@fhevm/sdk 1.1.0-alpha.2 → 1.1.0-alpha.4

package/core/modules/relayer/module/relayerUrl.ts

@@ -1,38 +1,77 @@
-import { removeSuffix } from '../../../base/string.js';
+import { assert } from '../../../base/errors/InternalError.js';
+import { InvalidUrlError } from '../../../base/errors/InvalidUrlError.js';
+import { removePrefix, removeSuffix } from '../../../base/string.js';
 
-export const ZamaMainnetRelayerBaseUrl = 'https://relayer.mainnet.zama.org';
-export const ZamaMainnetRelayerUrlV2 = `${ZamaMainnetRelayerBaseUrl}/v2`;
+/**
+ * Validates and normalizes a relayer URL before it's used to build the request.
+ *
+ * Validation:
+ *   - non-empty string
+ *   - parses as a URL
+ *   - protocol is `http:` or `https:`
+ *   - contains no userinfo (`user:pass@host`)
+ *   - contains no query string or fragment (they would corrupt path concatenation)
+ *   - if `hasAuth` is true, requires `https:` unless the host is localhost
+ *
+ * Normalization (via WHATWG `URL`):
+ *   - scheme and host lower-cased
+ *   - default ports collapsed (`:443` for https, `:80` for http)
+ *   - path percent-encoded canonically
+ *   - bare-origin URLs get a single trailing `/` (`https://x` → `https://x/`)
+ *
+ * Throws {@link InvalidUrlError} on any failure so the caller surfaces a
+ * uniform error type.
+ *
+ * @returns The normalized URL object.
+ */
+export function validateRelayerBaseUrl(relayerUrl: unknown, hasAuth: boolean): URL {
+  if (typeof relayerUrl !== 'string' || relayerUrl.length === 0) {
+    throw new InvalidUrlError({ message: 'Invalid relayerUrl: must be a non-empty string.' }, {});
+  }
 
-export const ZamaSepoliaRelayerBaseUrl = 'https://relayer.testnet.zama.org';
-export const ZamaSepoliaRelayerUrlV2 = `${ZamaSepoliaRelayerBaseUrl}/v2`;
+  let parsed: URL;
+  try {
+    parsed = new URL(relayerUrl);
+  } catch (cause) {
+    throw new InvalidUrlError({ message: `Invalid relayerUrl: cannot parse as URL}.`, cause }, {});
+  }
 
-export function parseZamaRelayerUrl(relayerUrl: unknown): string | null {
-  if (relayerUrl === undefined || relayerUrl === null || typeof relayerUrl !== 'string') {
-    return null;
+  if (parsed.protocol !== 'https:' && parsed.protocol !== 'http:') {
+    throw new InvalidUrlError(
+      { message: `Invalid relayerUrl protocol: ${parsed.protocol} (expected http: or https:).` },
+      {},
+    );
   }
 
-  const urlNoSlash = removeSuffix(relayerUrl, '/');
-  if (!URL.canParse(urlNoSlash)) {
-    return null;
+  if (parsed.username !== '' || parsed.password !== '') {
+    throw new InvalidUrlError(
+      { message: 'Invalid relayerUrl: URL must not contain credentials (user:pass@host).' },
+      {},
+    );
   }
 
-  if (urlNoSlash.startsWith(ZamaMainnetRelayerBaseUrl) || urlNoSlash.startsWith(ZamaSepoliaRelayerBaseUrl)) {
-    const zamaUrls = [
-      ZamaSepoliaRelayerBaseUrl,
-      ZamaSepoliaRelayerUrlV2,
-      ZamaMainnetRelayerBaseUrl,
-      ZamaMainnetRelayerUrlV2,
-    ];
-    const isZamaUrl = zamaUrls.includes(urlNoSlash);
-    if (isZamaUrl) {
-      if (urlNoSlash.endsWith('/v2')) {
-        return urlNoSlash;
-      }
-      return `${urlNoSlash}/v2`;
+  if (hasAuth && parsed.protocol === 'http:') {
+    const isLocalhost =
+      parsed.hostname === 'localhost' || parsed.hostname === '127.0.0.1' || parsed.hostname === '[::1]';
+    if (!isLocalhost) {
+      throw new InvalidUrlError(
+        { message: 'Invalid relayerUrl: HTTPS is required when auth credentials are provided.' },
+        {},
+      );
     }
-    // malformed Zama url
-    return null;
   }
 
-  return urlNoSlash;
+  // At the end of validateRelayerUrl, just before `return parsed;`
+  if (!parsed.pathname.endsWith('/')) {
+    parsed.pathname += '/';
+  }
+
+  return parsed;
+}
+
+export function buildRelayerUrlString(relayerBaseUrl: URL, path: string): string {
+  assert(relayerBaseUrl.pathname.endsWith('/'));
+  const sanitizedPath = removeSuffix(removePrefix(path, '/'), '/');
+  const url = new URL(sanitizedPath, relayerBaseUrl).toString();
+  return removeSuffix(url, '/');
 }

package/core/types/relayer.ts

@@ -34,6 +34,7 @@ export type FetchDelegatedUserDecryptResult = readonly FetchUserDecryptResultIte
 
 export type RelayerCommonOptions = {
   auth?: Auth | undefined;
+  headers?: Record<string, string>;
   debug?: boolean | undefined;
   fetchRetries?: number | undefined;
   fetchRetryDelayInMilliseconds?: number | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fhevm/sdk",
   "description": "TypeScript Interface for FHEVM",
-  "version": "1.1.0-alpha.2",
+  "version": "1.1.0-alpha.4",
   "type": "module",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",