lightnode-sdk 0.3.1 → 0.4.0

package/README.md

@@ -80,10 +80,48 @@ npx lightnode registered 0x6781…6e0f      # true | false | null
 npx lightnode fee llama3-8b               # on-chain job fee
 npx lightnode analytics --csv             # per-model performance (CSV)
 npx lightnode reliability --csv           # per-worker reliability (CSV)
+
+# Patch an existing project (auto-detects Next.js, Hono, or Node):
+npx lightnode add inference                    # encrypted inference route/script
+npx lightnode add chat                         # chat-style UI with conversation history
+npx lightnode add analytics-dashboard          # read-only network + worker analytics page
+npx lightnode add nft-mint-with-inference      # AI-generated NFT metadata with on-chain provenance
+# All `add` commands accept [--template auto|nextjs-api|hono|node] [--net testnet|mainnet] [--force]
+
+# Or scaffold a brand-new project:
+npm create lightnode-app my-app
 ```
 
 ## Submitting inference
 
+**Easy mode (`runInference` — v0.4+):** one async call drives the whole protocol —
+SIWE → prepareSession → on-chain createSession → relay WS → encrypt + upload prompt
+→ on-chain submitJob → decrypt streamed chunks → wait for `JobCompleted` →
+return the assembled answer + three tx hashes. Built-in retry on `StalledWorkerError`.
+
+```ts
+import { LightNode, GatewayClient, runInference } from "lightnode-sdk";
+import WS from "ws"; // omit in the browser
+
+const ln = new LightNode("testnet");
+const gateway = new GatewayClient({ network: "testnet", bearer: await getJwt() });
+const { answer, txs } = await runInference({
+  prompt: "Reply with a one-sentence fun fact about the ocean.",
+  gateway, wallet, publicClient, network: ln.network,
+  WebSocket: WS,
+  onChunk: (chunk) => process.stdout.write(chunk), // live streaming
+  maxRetries: 2,                                    // auto-retry on stall
+});
+console.log("\n", txs); // { createSession, submitJob, jobCompleted }
+```
+
+The lower-level helpers (`prepareSession`, `submitPrompt`, `decryptResponse`,
+the typed errors `StalledWorkerError` / `OnChainRevertError` / `GatewayAuthError`
+/ `RelayTokenTimeoutError`) stay exported for builders who want a different
+retry policy or to reuse a session across prompts.
+
+### Manual mode (the full surface)
+
 `v0.3+` ships the encrypted inference-submit flow end to end. Wire-compatible with
 the reference client [`lcai-chat-v2`](https://github.com/lightchain-protocol/lcai-chat-v2)
 (same ECDH-P256 + AES-256-GCM, same gateway endpoints, same `JobRegistry` calls).

package/dist/add.d.ts

@@ -0,0 +1,51 @@
+/**
+ * `lightnode add inference` - patch an EXISTING project to do encrypted
+ * LightChain AI inference. Detects the framework from package.json (Next.js,
+ * Hono, or plain Node) and writes the appropriate route/script + a .env.example
+ * if one isn't already there. Idempotent: existing files are not overwritten
+ * unless --force is passed.
+ *
+ * No runtime dependencies; templates are inlined as string literals.
+ */
+type Template = "nextjs-api" | "hono" | "node";
+type Network = "testnet" | "mainnet";
+interface AddOpts {
+    template?: Template | "auto";
+    network?: Network;
+    force?: boolean;
+    cwd?: string;
+}
+interface WrittenFile {
+    path: string;
+    skipped?: boolean;
+    reason?: string;
+}
+/**
+ * Implementation called by `lightnode add inference [...]`.
+ * Returns the list of files written + the install command the user should run.
+ */
+export declare function addInference(opts?: AddOpts): {
+    written: WrittenFile[];
+    install: string;
+    template: Template;
+    network: Network;
+};
+export declare function addAnalyticsDashboard(opts?: AddOpts): {
+    written: WrittenFile[];
+    install: string;
+    template: Template;
+    network: Network;
+};
+export declare function addChat(opts?: AddOpts): {
+    written: WrittenFile[];
+    install: string;
+    template: Template;
+    network: Network;
+};
+export declare function addNftMint(opts?: AddOpts): {
+    written: WrittenFile[];
+    install: string;
+    template: Template;
+    network: Network;
+};
+export {};