@keldra/sdk 0.1.1 → 0.1.3

package/README.md

@@ -2,6 +2,12 @@
 
 TypeScript SDK for the Keldra relay API.
 
+## Security
+
+- Use this SDK with a server-side API key only.
+- Never ship `kk_...` keys in browser/client bundles.
+- Keep `KELDRA_API_KEY` in backend environment variables.
+
 ## Install
 
 ```bash
@@ -26,7 +32,7 @@ npm install @keldra/sdk viem
 ```ts
 import { KeldraClient } from "@keldra/sdk";
 
-const client = KeldraClient.create("kk_your_api_key");
+const client = KeldraClient.fromEnv();
 const result = await client.relay("ethereum", signedTxHex);
 const limits = await client.limits();
 const usage = await client.usage("2026-02-01", "2026-02-20");
@@ -52,6 +58,32 @@ import { KeldraClient } from "@keldra/sdk";
 const client = KeldraClient.fromEnv();
 ```
 
+## Backend Proxy Example (Next.js)
+
+Keep Keldra calls on your server route:
+
+```ts
+// app/api/relay/route.ts
+import { NextRequest, NextResponse } from "next/server";
+import { KeldraClient } from "@keldra/sdk";
+
+const client = KeldraClient.fromEnv();
+
+export async function POST(req: NextRequest) {
+  const body = await req.json();
+  const { chain, signedTx } = body as { chain: "ethereum"; signedTx: string };
+
+  if (!chain || !signedTx) {
+    return NextResponse.json({ error: "chain and signedTx are required" }, { status: 400 });
+  }
+
+  const relay = await client.relay(chain, signedTx);
+  return NextResponse.json(relay);
+}
+```
+
+Frontend calls your backend endpoint, not Keldra directly.
+
 ## Encrypted Transport
 
 ```ts

package/dist/index.cjs

@@ -166,6 +166,9 @@ var DEFAULT_POLL_INTERVAL_MS = 2e3;
 var MAX_POLL_INTERVAL_MS = 15e3;
 var DEFAULT_API_KEY_ENV = "KELDRA_API_KEY";
 var DEFAULT_GATEWAY_ENV = "KELDRA_GATEWAY_URL";
+function isBrowserRuntime() {
+  return typeof window !== "undefined" && typeof document !== "undefined";
+}
 var KeldraClient = class _KeldraClient {
   
   
@@ -179,6 +182,11 @@ var KeldraClient = class _KeldraClient {
     if (!config.apiKey) {
       throw KeldraError.config("apiKey is required");
     }
+    if (isBrowserRuntime() && config.apiKey.startsWith("kk_")) {
+      throw KeldraError.config(
+        "Do not use a Keldra API key in browser code. Move SDK calls to your backend."
+      );
+    }
     this.http = new HttpClient(config.apiKey);
     this.gatewayUrl = (_nullishCoalesce(config.gatewayUrl, () => ( DEFAULT_GATEWAY_URL))).replace(
       /\/$/,
@@ -195,6 +203,11 @@ var KeldraClient = class _KeldraClient {
     return new _KeldraClient({ apiKey });
   }
   static fromEnv(env = _nullishCoalesce(_optionalChain([globalThis, 'access', _2 => _2.process, 'optionalAccess', _3 => _3.env]), () => ( {})), options) {
+    if (isBrowserRuntime()) {
+      throw KeldraError.config(
+        "KeldraClient.fromEnv() is server-only. Load KELDRA_API_KEY on your backend."
+      );
+    }
     const apiKeyName = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _4 => _4.apiKeyEnv]), () => ( DEFAULT_API_KEY_ENV));
     const gatewayUrlName = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _5 => _5.gatewayUrlEnv]), () => ( DEFAULT_GATEWAY_ENV));
     const apiKey = env[apiKeyName];

package/dist/index.js

@@ -166,6 +166,9 @@ var DEFAULT_POLL_INTERVAL_MS = 2e3;
 var MAX_POLL_INTERVAL_MS = 15e3;
 var DEFAULT_API_KEY_ENV = "KELDRA_API_KEY";
 var DEFAULT_GATEWAY_ENV = "KELDRA_GATEWAY_URL";
+function isBrowserRuntime() {
+  return typeof window !== "undefined" && typeof document !== "undefined";
+}
 var KeldraClient = class _KeldraClient {
   http;
   gatewayUrl;
@@ -179,6 +182,11 @@ var KeldraClient = class _KeldraClient {
     if (!config.apiKey) {
       throw KeldraError.config("apiKey is required");
     }
+    if (isBrowserRuntime() && config.apiKey.startsWith("kk_")) {
+      throw KeldraError.config(
+        "Do not use a Keldra API key in browser code. Move SDK calls to your backend."
+      );
+    }
     this.http = new HttpClient(config.apiKey);
     this.gatewayUrl = (config.gatewayUrl ?? DEFAULT_GATEWAY_URL).replace(
       /\/$/,
@@ -195,6 +203,11 @@ var KeldraClient = class _KeldraClient {
     return new _KeldraClient({ apiKey });
   }
   static fromEnv(env = globalThis.process?.env ?? {}, options) {
+    if (isBrowserRuntime()) {
+      throw KeldraError.config(
+        "KeldraClient.fromEnv() is server-only. Load KELDRA_API_KEY on your backend."
+      );
+    }
     const apiKeyName = options?.apiKeyEnv ?? DEFAULT_API_KEY_ENV;
     const gatewayUrlName = options?.gatewayUrlEnv ?? DEFAULT_GATEWAY_ENV;
     const apiKey = env[apiKeyName];

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "@keldra/sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "TypeScript SDK for Keldra relay API",
   "license": "MIT",
   "author": "Keldra",
-  "homepage": "https://keldra.network",
+  "homepage": "https://github.com/jperth86/keldra-sdk#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jperth86/keldra-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jperth86/keldra-sdk/issues"
+  },
   "keywords": [
     "keldra",
     "relay",