@iicp/web-node 0.1.0

package/LICENSE

@@ -0,0 +1,180 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and its Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or otherwise designated in writing by the copyright owner as
+      "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and incorporated
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or in combination with the Work to which such
+      Contribution(s) was submitted. If You institute patent litigation
+      against any entity (including a cross-claim or counterclaim in a
+      lawsuit) alleging that the Work or a Contribution incorporated within
+      the Work constitutes direct or contributory patent infringement, then
+      any patent licenses granted to You under this License for that Work
+      shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work,
+      and to permit persons to whom the Work is furnished to do so, subject
+      to Your separate additional terms and conditions.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any conditions of title,
+      non-infringement, merchantability, or fitness for a particular
+      purpose. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions fully consistent with this License to any recipient of
+      the Work.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Rob Lemumin
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,68 @@
+# @iicp/web-node
+
+Browser-native **IICP node** for the [IICP](https://iicp.network) mesh — **consume** AI
+from the network *and* **serve** a model from a browser tab. ESM, built on the platform's
+native `fetch` / `SubtleCrypto` / WebGPU (and runs in Node ≥18). End-to-end payload
+encryption is **mandatory** and on by default.
+
+```
+npm install @iicp/web-node
+```
+
+## Consume — call the mesh
+
+```ts
+import { IicpBrowserClient, nodeCxKey } from "@iicp/web-node";
+
+const client = new IicpBrowserClient(); // defaults to https://iicp.network
+const nodes = await client.discover("urn:iicp:intent:llm:chat:v1");
+// By default, discover() keeps only browser-usable HTTPS/loopback endpoints.
+// Pass { browser_usable_only: false } if you are running in Node and want all routes.
+
+const node = nodes[0];
+const reply = await client.chat(
+  [{ role: "user", content: "Hello!" }],
+  { endpoint: node.endpoint, model: "llama3", cxPublicKey: nodeCxKey(node) },
+);
+```
+
+When the chosen node advertises an encryption key (`nodeCxKey(node)`), the payload is
+**sealed end-to-end** — the directory, relays, and network see only ciphertext. There is
+no opt-out. A node that does not advertise `cx_public_key`/`public_key` is refused before
+any network send so browser use cannot silently fall back to plaintext.
+
+## Serve — be a node from the browser
+
+```ts
+import { BrowserNodeProvider, WEBLLM_MODELS, assessDevice } from "@iicp/web-node";
+// Loads a small model in-tab via WebLLM (WebGPU/WASM) and serves it behind a relay.
+```
+
+Browser providers advertise a generated `cx_public_key`, decrypt incoming `iicp_conf`
+payloads locally, report task success/failure/latency in heartbeats, and use a relay path
+because browser tabs cannot accept raw inbound TCP.
+
+Serving requires WebLLM — add it alongside this package:
+
+```
+npm install @mlc-ai/web-llm   # peer dependency, only needed to serve
+```
+
+## Encryption
+
+IICP-CX (S.16) Tier-1: ephemeral **X25519** key agreement → **HKDF-SHA256** →
+**AES-256-GCM** authenticated encryption, computed with `@noble/curves` + `@noble/hashes`
+and the platform's `SubtleCrypto`. The envelope is wire-compatible with the Python,
+TypeScript, and Rust IICP clients and the provider/adapter that decrypts it.
+
+## CORS reality
+
+Discovery (`GET /api/v1/discover`) works from any `https://` page because `iicp.network`
+sends CORS headers. Routing a task to a discovered node is subject to the browser's CORS
+and mixed-content policy: an `https://` page cannot reach an `http://localhost` model, a
+node without CORS headers, or an IPv6-firewalled node. In **Node** there is no CORS
+restriction and everything works.
+
+## License
+
+Apache-2.0. Part of the open [IICP protocol](https://github.com/RobLe3/IICP).

package/dist/browserNodeProvider.d.ts

@@ -0,0 +1,73 @@
+import type { ChatMessage } from "./iicpConsumer.js";
+export interface BrowserProviderRuntime {
+    chat(messages: ChatMessage[], opts?: {
+        temperature?: number;
+        max_tokens?: number;
+    }): Promise<string>;
+}
+export interface BrowserProviderConfig {
+    /** Relay node base URL, e.g. "http://127.0.0.1:9484". Required. */
+    relayUrl: string;
+    /** Directory API base. Default: "https://iicp.network/api". */
+    directoryUrl?: string;
+    /** Model name advertised to the directory (the loaded WebLLM model id). */
+    model: string;
+    region?: string;
+    onLog?: (line: string) => void;
+    /** Called after each served task with the running total. */
+    onTaskServed?: (total: number) => void;
+    onStateChange?: (state: BrowserProviderState) => void;
+}
+export type BrowserProviderState = "stopped" | "starting" | "serving" | "error";
+export declare const BROWSER_NODE_SDK_VERSION = "0.7.71-browser";
+/**
+ * Coarse region autodetect from the browser's timezone (no network, no
+ * geolocation permission). Matches the mesh's region convention
+ * (eu-central / us-east / …) as a SCORING HINT — deliberately coarse;
+ * operators can override via config. "(Browser)" is shown separately on
+ * the nodes page via sdk_language.
+ */
+export declare function detectRegion(): string;
+export interface DiscoveredRelay {
+    endpoint: string;
+    nodeId: string;
+    reputation: number;
+    probation: boolean;
+}
+export declare function discoverRelay(directoryUrl?: string): Promise<DiscoveredRelay | null>;
+export declare class BrowserProviderError extends Error {
+    readonly stage: "register" | "bind" | "serve";
+    constructor(message: string, stage: "register" | "bind" | "serve");
+}
+export declare class BrowserNodeProvider {
+    private readonly runtime;
+    private readonly cfg;
+    readonly nodeId: string;
+    private _state;
+    private _nodeToken;
+    private _sessionToken;
+    private _tasksServed;
+    private _okSinceBeat;
+    private _failSinceBeat;
+    private _latencyMsSinceBeat;
+    private readonly _cx;
+    private _heartbeatTimer;
+    private _stopRequested;
+    /** True when the directory accepted the registration (mesh-discoverable). */
+    directoryListed: boolean;
+    constructor(runtime: BrowserProviderRuntime, cfg: BrowserProviderConfig);
+    get state(): BrowserProviderState;
+    get tasksServed(): number;
+    private get directoryBase();
+    private get relayBase();
+    private log;
+    private setState;
+    /** Register → bind → start serving. Throws BrowserProviderError on failure. */
+    start(): Promise<void>;
+    /** Unbind from the relay and deregister from the directory. */
+    stop(): Promise<void>;
+    private unbindQuietly;
+    private heartbeat;
+    private pollLoop;
+    private serveCall;
+}