@fhevm/sdk 0.14.4 → 0.14.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/_cjs/core/_version.js +1 -1
  2. package/_cjs/core/chains/definitions/bscTestnet.js +36 -0
  3. package/_cjs/core/chains/definitions/bscTestnet.js.map +1 -0
  4. package/_cjs/core/chains/index.js +3 -1
  5. package/_cjs/core/chains/index.js.map +1 -1
  6. package/_cjs/core/modules/relayer/module/RelayerAsyncRequest.js +12 -2
  7. package/_cjs/core/modules/relayer/module/RelayerAsyncRequest.js.map +1 -1
  8. package/_cjs/core/modules/relayer/module/fetchFheEncryptionKeySource.js +5 -3
  9. package/_cjs/core/modules/relayer/module/fetchFheEncryptionKeySource.js.map +1 -1
  10. package/_cjs/core/modules/relayer/module/relayerUrl.js +37 -0
  11. package/_cjs/core/modules/relayer/module/relayerUrl.js.map +1 -1
  12. package/_cjs/wasm/tfhe/loadTfheLib.js.map +1 -1
  13. package/_cjs/wasm/tkms/loadKmsLib.js.map +1 -1
  14. package/_esm/core/_version.js +1 -1
  15. package/_esm/core/chains/definitions/bscTestnet.js +33 -0
  16. package/_esm/core/chains/definitions/bscTestnet.js.map +1 -0
  17. package/_esm/core/chains/index.js +1 -0
  18. package/_esm/core/chains/index.js.map +1 -1
  19. package/_esm/core/modules/relayer/module/RelayerAsyncRequest.js +14 -2
  20. package/_esm/core/modules/relayer/module/RelayerAsyncRequest.js.map +1 -1
  21. package/_esm/core/modules/relayer/module/fetchFheEncryptionKeySource.js +7 -4
  22. package/_esm/core/modules/relayer/module/fetchFheEncryptionKeySource.js.map +1 -1
  23. package/_esm/core/modules/relayer/module/relayerUrl.js +48 -1
  24. package/_esm/core/modules/relayer/module/relayerUrl.js.map +1 -1
  25. package/_types/core/chains/definitions/bscTestnet.d.ts +3 -0
  26. package/_types/core/chains/definitions/bscTestnet.d.ts.map +1 -0
  27. package/_types/core/chains/index.d.ts +1 -0
  28. package/_types/core/chains/index.d.ts.map +1 -1
  29. package/_types/core/modules/relayer/module/RelayerAsyncRequest.d.ts +1 -0
  30. package/_types/core/modules/relayer/module/RelayerAsyncRequest.d.ts.map +1 -1
  31. package/_types/core/modules/relayer/module/fetchFheEncryptionKeySource.d.ts.map +1 -1
  32. package/_types/core/modules/relayer/module/relayerUrl.d.ts +12 -1
  33. package/_types/core/modules/relayer/module/relayerUrl.d.ts.map +1 -1
  34. package/_types/core/types/relayer.d.ts +6 -0
  35. package/_types/core/types/relayer.d.ts.map +1 -1
  36. package/core/_version.ts +1 -1
  37. package/core/chains/definitions/bscTestnet.ts +34 -0
  38. package/core/chains/index.ts +1 -0
  39. package/core/modules/relayer/module/RelayerAsyncRequest.ts +11 -2
  40. package/core/modules/relayer/module/fetchFheEncryptionKeySource.ts +12 -4
  41. package/core/modules/relayer/module/relayerUrl.ts +52 -1
  42. package/core/types/relayer.ts +6 -0
  43. package/package.json +1 -1
@@ -10,7 +10,12 @@ import { assertRecordArrayProperty, assertRecordNonNullableProperty } from '../.
10
10
  import { fetchWithRetry, normalizeHeaders } from '../../../base/fetch.js';
11
11
  import { sdkName, version } from '../../../_version.js';
12
12
  import { assertRecordStringArrayProperty, assertRecordStringProperty } from '../../../base/string.js';
13
- import { buildRelayerUrlString, validateRelayerBaseUrl } from './relayerUrl.js';
13
+ import {
14
+ appendRelayerQuery,
15
+ buildRelayerUrlString,
16
+ normalizeRelayerQuery,
17
+ validateRelayerBaseUrl,
18
+ } from './relayerUrl.js';
14
19
  import { readErrorMessage } from './readErrorMessage.js';
15
20
  import { assert } from '../../../base/errors/InternalError.js';
16
21
 
@@ -25,6 +30,7 @@ export async function fetchFheEncryptionKeySource(
25
30
  const { options } = parameters;
26
31
  const relayerBaseUrl: URL = validateRelayerBaseUrl(relayerClient.relayerUrl, options?.auth !== undefined);
27
32
  const customHeaders = normalizeHeaders(options?.headers);
33
+ const query = normalizeRelayerQuery(options?.query);
28
34
  const init = setAuth(
29
35
  {
30
36
  method: 'GET',
@@ -38,12 +44,14 @@ export async function fetchFheEncryptionKeySource(
38
44
  );
39
45
 
40
46
  assert(relayerBaseUrl.pathname.endsWith('/'));
47
+ // Keep `url` query-less so errors and logs show the endpoint, not per-request metadata.
41
48
  const url = buildRelayerUrlString(relayerBaseUrl, 'v2/keyurl');
49
+ const fetchUrl = appendRelayerQuery(url, query);
42
50
 
43
51
  let response;
44
52
  try {
45
53
  response = await fetchWithRetry({
46
- url,
54
+ url: fetchUrl,
47
55
  init,
48
56
  retries: options?.fetchRetries,
49
57
  retryDelayMs: options?.fetchRetryDelayInMilliseconds,
@@ -68,8 +76,8 @@ export async function fetchFheEncryptionKeySource(
68
76
  url,
69
77
  message:
70
78
  message !== undefined
71
- ? `HTTP error! status: ${response.status} on ${response.url}: ${message}`
72
- : `HTTP error! status: ${response.status} on ${response.url}`,
79
+ ? `HTTP error! status: ${response.status} on ${url}: ${message}`
80
+ : `HTTP error! status: ${response.status} on ${url}`,
73
81
  });
74
82
  }
75
83
 
@@ -10,7 +10,6 @@ import { removePrefix, removeSuffix } from '../../../base/string.js';
10
10
  * - parses as a URL
11
11
  * - protocol is `http:` or `https:`
12
12
  * - contains no userinfo (`user:pass@host`)
13
- * - contains no query string or fragment (they would corrupt path concatenation)
14
13
  * - if `hasAuth` is true, requires `https:` unless the host is localhost
15
14
  *
16
15
  * Normalization (via WHATWG `URL`):
@@ -18,6 +17,7 @@ import { removePrefix, removeSuffix } from '../../../base/string.js';
18
17
  * - default ports collapsed (`:443` for https, `:80` for http)
19
18
  * - path percent-encoded canonically
20
19
  * - bare-origin URLs get a single trailing `/` (`https://x` → `https://x/`)
20
+ * - query string and fragment dropped, with a warning (use `options.query` instead)
21
21
  *
22
22
  * Throws {@link InvalidUrlError} on any failure so the caller surfaces a
23
23
  * uniform error type.
@@ -50,6 +50,17 @@ export function validateRelayerBaseUrl(relayerUrl: unknown, hasAuth: boolean): U
50
50
  );
51
51
  }
52
52
 
53
+ // Patch releases keep the old behavior: drop the query and fragment instead of throwing.
54
+ // The warning leaves out the value, which may hold a secret (`?apikey=...`).
55
+ // Check `href`, not `search` / `hash`, which are '' for a bare trailing `?` or `#`.
56
+ if (parsed.href.includes('?') || parsed.href.includes('#')) {
57
+ console.warn(
58
+ 'relayerUrl contains a query string or fragment, which is ignored. Use options.query to add query parameters.',
59
+ );
60
+ parsed.search = '';
61
+ parsed.hash = '';
62
+ }
63
+
53
64
  if (hasAuth && parsed.protocol === 'http:') {
54
65
  const isLocalhost =
55
66
  parsed.hostname === 'localhost' || parsed.hostname === '127.0.0.1' || parsed.hostname === '[::1]';
@@ -75,3 +86,43 @@ export function buildRelayerUrlString(relayerBaseUrl: URL, path: string): string
75
86
  const url = new URL(sanitizedPath, relayerBaseUrl).toString();
76
87
  return removeSuffix(url, '/');
77
88
  }
89
+
90
+ /**
91
+ * Validates `options.query` once at intake and returns a detached copy of its string entries.
92
+ *
93
+ * @throws If a key or value cannot be percent-encoded, so a bad query fails here and not as a generic fetch error.
94
+ */
95
+ export function normalizeRelayerQuery(query: unknown): Readonly<Record<string, string>> | undefined {
96
+ if (query === null || typeof query !== 'object' || Array.isArray(query)) {
97
+ return undefined;
98
+ }
99
+ const result: Record<string, string> = {};
100
+ for (const [key, value] of Object.entries(query)) {
101
+ if (typeof value !== 'string') {
102
+ continue;
103
+ }
104
+ try {
105
+ encodeURIComponent(key);
106
+ encodeURIComponent(value);
107
+ } catch (cause) {
108
+ throw new Error(`normalizeRelayerQuery: query parameter '${key}' cannot be percent-encoded`, { cause });
109
+ }
110
+ result[key] = value;
111
+ }
112
+ return result;
113
+ }
114
+
115
+ /**
116
+ * Use the result only as the URL passed to `fetch()`. Keep the query-less `url`
117
+ * for errors, logs and callbacks, so they show the endpoint, not per-request metadata.
118
+ */
119
+ export function appendRelayerQuery(url: string, query: Readonly<Record<string, string>> | undefined): string {
120
+ const search = Object.entries(query ?? {})
121
+ .map(([key, value]) => `${encodeURIComponent(key)}=${encodeURIComponent(value)}`)
122
+ .join('&');
123
+ if (search === '') {
124
+ return url;
125
+ }
126
+ assert(!url.includes('?'));
127
+ return `${url}?${search}`;
128
+ }
@@ -35,6 +35,12 @@ export type FetchDelegatedUserDecryptResult = readonly FetchUserDecryptResultIte
35
35
  export type RelayerCommonOptions = {
36
36
  auth?: Auth | undefined;
37
37
  headers?: Record<string, string>;
38
+ /**
39
+ * Extra query parameters sent with job requests and the key-URL lookup.
40
+ * Used by the Zama SDK to send its metadata (`zama_*`) when a proxy in front
41
+ * of the relayer doesn't forward custom headers. Prefer `headers`.
42
+ */
43
+ query?: Record<string, string> | undefined;
38
44
  debug?: boolean | undefined;
39
45
  fetchRetries?: number | undefined;
40
46
  fetchRetryDelayInMilliseconds?: number | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@fhevm/sdk",
3
3
  "description": "TypeScript Interface for FHEVM",
4
- "version": "0.14.4",
4
+ "version": "0.14.5",
5
5
  "type": "module",
6
6
  "main": "./_cjs/index.js",
7
7
  "module": "./_esm/index.js",