@fhevm/sdk 1.1.0-alpha.5 → 1.1.0-alpha.6

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 (145) hide show
  1. package/_cjs/core/_version.js +1 -1
  2. package/_cjs/core/base/bytes.js +2 -1
  3. package/_cjs/core/base/bytes.js.map +1 -1
  4. package/_cjs/core/base/environment.js +122 -0
  5. package/_cjs/core/base/environment.js.map +1 -0
  6. package/_cjs/core/base/errors/Sha256VerificationError.js +15 -0
  7. package/_cjs/core/base/errors/Sha256VerificationError.js.map +1 -0
  8. package/_cjs/core/base/inflate.js +282 -0
  9. package/_cjs/core/base/inflate.js.map +1 -0
  10. package/_cjs/core/base/isomorphicFs.js +24 -0
  11. package/_cjs/core/base/isomorphicFs.js.map +1 -0
  12. package/_cjs/core/base/isomorphicWorker.js +42 -111
  13. package/_cjs/core/base/isomorphicWorker.js.map +1 -1
  14. package/_cjs/core/base/wasm.js +15 -55
  15. package/_cjs/core/base/wasm.js.map +1 -1
  16. package/_cjs/core/kms/TransportKeyPair-p.js +0 -4
  17. package/_cjs/core/kms/TransportKeyPair-p.js.map +1 -1
  18. package/_cjs/core/kms/createKmsUserDecryptEip712.js +5 -1
  19. package/_cjs/core/kms/createKmsUserDecryptEip712.js.map +1 -1
  20. package/_cjs/core/modules/decrypt/module/init-p.js +124 -39
  21. package/_cjs/core/modules/decrypt/module/init-p.js.map +1 -1
  22. package/_cjs/core/modules/encrypt/module/init-p.js +148 -45
  23. package/_cjs/core/modules/encrypt/module/init-p.js.map +1 -1
  24. package/_cjs/core/runtime/HyperWasmSolver-p.js +4 -4
  25. package/_cjs/core/runtime/initFhevmEncryptRuntime-p.js +1 -1
  26. package/_cjs/core/runtime/initFhevmRuntime-p.js +1 -1
  27. package/_cjs/wasm/tfhe/TfheApi.d.ts +12 -12
  28. package/_cjs/wasm/tfhe/loadTfheLib.js +11 -11
  29. package/_cjs/wasm/tfhe/loadTfheLib.js.map +2 -2
  30. package/_cjs/wasm/tfhe/v1.5.3/startWorkers.js +26 -9
  31. package/_cjs/wasm/tfhe/v1.5.3/startWorkers.js.map +2 -2
  32. package/_cjs/wasm/tfhe/v1.5.3/tfhe.d.ts +3 -0
  33. package/_cjs/wasm/tfhe/{v1.6.1 → v1.6.2}/startWorkers.js +28 -11
  34. package/_cjs/wasm/tfhe/v1.6.2/startWorkers.js.map +7 -0
  35. package/{_esm/wasm/tfhe/v1.6.1 → _cjs/wasm/tfhe/v1.6.2}/tfhe-worker.mjs +40 -40
  36. package/{_esm/wasm/tfhe/v1.6.1 → _cjs/wasm/tfhe/v1.6.2}/tfhe.d.ts +88 -85
  37. package/_cjs/wasm/tfhe/{v1.6.1 → v1.6.2}/tfhe.js +245 -442
  38. package/_cjs/wasm/tfhe/v1.6.2/tfhe.js.map +7 -0
  39. package/_cjs/wasm/tfhe/v1.6.2/tfhe_bg.wasm +0 -0
  40. package/_cjs/wasm/tfhe/v1.6.2/tfhe_bg.wasm.base64.js +35 -0
  41. package/_cjs/wasm/tfhe/v1.6.2/tfhe_bg.wasm.base64.js.map +7 -0
  42. package/_cjs/wasm/tkms/loadKmsLib.js.map +1 -1
  43. package/_cjs/wasm/wasmBaseUrl.js +8 -19
  44. package/_cjs/wasm/wasmBaseUrl.js.map +2 -2
  45. package/_esm/core/_version.js +1 -1
  46. package/_esm/core/base/bytes.js +2 -1
  47. package/_esm/core/base/bytes.js.map +1 -1
  48. package/_esm/core/base/environment.js +164 -0
  49. package/_esm/core/base/environment.js.map +1 -0
  50. package/_esm/core/base/errors/Sha256VerificationError.js +11 -0
  51. package/_esm/core/base/errors/Sha256VerificationError.js.map +1 -0
  52. package/_esm/core/base/inflate.js +337 -0
  53. package/_esm/core/base/inflate.js.map +1 -0
  54. package/_esm/core/base/isomorphicFs.js +21 -0
  55. package/_esm/core/base/isomorphicFs.js.map +1 -0
  56. package/_esm/core/base/isomorphicWorker.js +92 -85
  57. package/_esm/core/base/isomorphicWorker.js.map +1 -1
  58. package/_esm/core/base/wasm.js +25 -31
  59. package/_esm/core/base/wasm.js.map +1 -1
  60. package/_esm/core/kms/TransportKeyPair-p.js +0 -4
  61. package/_esm/core/kms/TransportKeyPair-p.js.map +1 -1
  62. package/_esm/core/kms/createKmsUserDecryptEip712.js +5 -1
  63. package/_esm/core/kms/createKmsUserDecryptEip712.js.map +1 -1
  64. package/_esm/core/modules/decrypt/module/init-p.js +109 -54
  65. package/_esm/core/modules/decrypt/module/init-p.js.map +1 -1
  66. package/_esm/core/modules/encrypt/module/init-p.js +300 -53
  67. package/_esm/core/modules/encrypt/module/init-p.js.map +1 -1
  68. package/_esm/core/runtime/HyperWasmSolver-p.js +4 -4
  69. package/_esm/core/runtime/initFhevmEncryptRuntime-p.js +1 -1
  70. package/_esm/core/runtime/initFhevmRuntime-p.js +1 -1
  71. package/_esm/wasm/tfhe/TfheApi.d.ts +12 -12
  72. package/_esm/wasm/tfhe/loadTfheLib.js +11 -11
  73. package/_esm/wasm/tfhe/v1.5.3/startWorkers.js +41 -20
  74. package/_esm/wasm/tfhe/v1.5.3/tfhe.d.ts +3 -0
  75. package/_esm/wasm/tfhe/{v1.6.1 → v1.6.2}/startWorkers.js +46 -25
  76. package/{_cjs/wasm/tfhe/v1.6.1 → _esm/wasm/tfhe/v1.6.2}/tfhe-worker.mjs +40 -40
  77. package/{_types/wasm/tfhe/v1.6.1 → _esm/wasm/tfhe/v1.6.2}/tfhe.d.ts +88 -85
  78. package/_esm/wasm/tfhe/{v1.6.1 → v1.6.2}/tfhe.js +245 -442
  79. package/_esm/wasm/tfhe/v1.6.2/tfhe_bg.wasm +0 -0
  80. package/_esm/wasm/tfhe/v1.6.2/tfhe_bg.wasm.base64.js +7 -0
  81. package/_esm/wasm/wasmBaseUrl.js +17 -54
  82. package/_types/core/base/bytes.d.ts.map +1 -1
  83. package/_types/core/base/environment.d.ts +92 -0
  84. package/_types/core/base/environment.d.ts.map +1 -0
  85. package/_types/core/base/errors/Sha256VerificationError.d.ts +14 -0
  86. package/_types/core/base/errors/Sha256VerificationError.d.ts.map +1 -0
  87. package/_types/core/base/inflate.d.ts +25 -0
  88. package/_types/core/base/inflate.d.ts.map +1 -0
  89. package/_types/core/base/isomorphicFs.d.ts +2 -0
  90. package/_types/core/base/isomorphicFs.d.ts.map +1 -0
  91. package/_types/core/base/isomorphicWorker.d.ts +27 -43
  92. package/_types/core/base/isomorphicWorker.d.ts.map +1 -1
  93. package/_types/core/base/wasm.d.ts +0 -8
  94. package/_types/core/base/wasm.d.ts.map +1 -1
  95. package/_types/core/kms/TransportKeyPair-p.d.ts.map +1 -1
  96. package/_types/core/kms/createKmsUserDecryptEip712.d.ts.map +1 -1
  97. package/_types/core/modules/decrypt/module/init-p.d.ts.map +1 -1
  98. package/_types/core/modules/encrypt/module/init-p.d.ts.map +1 -1
  99. package/_types/core/types/wasmAssets.d.ts.map +1 -1
  100. package/_types/wasm/tfhe/TfheApi.d.ts +12 -12
  101. package/_types/wasm/tfhe/v1.5.3/tfhe.d.ts +3 -0
  102. package/{wasm/tfhe/v1.6.1 → _types/wasm/tfhe/v1.6.2}/tfhe.d.ts +88 -85
  103. package/core/_version.ts +1 -1
  104. package/core/base/bytes.ts +2 -1
  105. package/core/base/environment.ts +210 -0
  106. package/core/base/errors/Sha256VerificationError.ts +22 -0
  107. package/core/base/inflate.ts +373 -0
  108. package/core/base/isomorphicFs.ts +23 -0
  109. package/core/base/isomorphicWorker.ts +96 -123
  110. package/core/base/wasm.ts +28 -35
  111. package/core/kms/TransportKeyPair-p.ts +0 -5
  112. package/core/kms/createKmsUserDecryptEip712.ts +8 -1
  113. package/core/modules/decrypt/module/init-p.ts +148 -59
  114. package/core/modules/encrypt/module/init-p.ts +368 -63
  115. package/core/runtime/HyperWasmSolver-p.ts +4 -4
  116. package/core/runtime/initFhevmEncryptRuntime-p.ts +1 -1
  117. package/core/runtime/initFhevmRuntime-p.ts +1 -1
  118. package/core/types/wasmAssets.ts +58 -0
  119. package/package.json +1 -1
  120. package/wasm/tfhe/TfheApi.d.ts +12 -12
  121. package/wasm/tfhe/loadTfheLib.js +11 -11
  122. package/wasm/tfhe/v1.5.3/startWorkers.js +41 -20
  123. package/wasm/tfhe/v1.5.3/tfhe.d.ts +3 -0
  124. package/wasm/tfhe/v1.6.0-dev/startWorkers.js +41 -20
  125. package/wasm/tfhe/v1.6.0-dev/tfhe.d.ts +3 -0
  126. package/wasm/tfhe/{v1.6.1 → v1.6.2}/startWorkers.js +46 -25
  127. package/wasm/tfhe/{v1.6.1 → v1.6.2}/tfhe-worker.mjs +40 -40
  128. package/{_cjs/wasm/tfhe/v1.6.1 → wasm/tfhe/v1.6.2}/tfhe.d.ts +88 -85
  129. package/wasm/tfhe/{v1.6.1 → v1.6.2}/tfhe.js +245 -442
  130. package/wasm/tfhe/v1.6.2/tfhe_bg.wasm +0 -0
  131. package/wasm/tfhe/v1.6.2/tfhe_bg.wasm.base64.js +7 -0
  132. package/wasm/wasmBaseUrl.js +17 -54
  133. package/_cjs/wasm/tfhe/v1.6.1/startWorkers.js.map +0 -7
  134. package/_cjs/wasm/tfhe/v1.6.1/tfhe.js.map +0 -7
  135. package/_cjs/wasm/tfhe/v1.6.1/tfhe_bg.wasm +0 -0
  136. package/_cjs/wasm/tfhe/v1.6.1/tfhe_bg.wasm.base64.js +0 -35
  137. package/_cjs/wasm/tfhe/v1.6.1/tfhe_bg.wasm.base64.js.map +0 -7
  138. package/_esm/wasm/tfhe/v1.6.1/tfhe_bg.wasm +0 -0
  139. package/_esm/wasm/tfhe/v1.6.1/tfhe_bg.wasm.base64.js +0 -7
  140. package/wasm/tfhe/v1.6.1/tfhe_bg.wasm +0 -0
  141. package/wasm/tfhe/v1.6.1/tfhe_bg.wasm.base64.js +0 -7
  142. /package/_cjs/wasm/tfhe/{v1.6.1 → v1.6.2}/tfhe_bg.wasm.base64.d.ts +0 -0
  143. /package/_esm/wasm/tfhe/{v1.6.1 → v1.6.2}/tfhe_bg.wasm.base64.d.ts +0 -0
  144. /package/_types/wasm/tfhe/{v1.6.1 → v1.6.2}/tfhe_bg.wasm.base64.d.ts +0 -0
  145. /package/wasm/tfhe/{v1.6.1 → v1.6.2}/tfhe_bg.wasm.base64.d.ts +0 -0
@@ -6,20 +6,112 @@ import type {
6
6
  TfheModuleInfo,
7
7
  } from '../types.js';
8
8
  import type { TfheLibApi } from '../../../../wasm/tfhe/TfheApi.js';
9
- import type { TfheAssetMetadata, TfheVersion } from '../../../../wasm/tfhe/loadTfheLib.js';
9
+ import type { TfheAssetMetadata, TfheAssets, TfheVersion } from '../../../../wasm/tfhe/loadTfheLib.js';
10
+ import type { WasmAssetLoadMode } from '../../../types/wasmAssets.js';
10
11
  import { isomorphicCompileVerifiedWasm, isomorphicCompileWasmFromBase64 } from '../../../base/wasm.js';
11
- import { isBlobWorkerSupported, isBrowserLike } from '../../../base/isomorphicWorker.js';
12
+ import { isBlobWorkerSupported } from '../../../base/isomorphicWorker.js';
13
+ import { isBrowserLike } from '../../../base/environment.js';
12
14
  import { threads } from 'wasm-feature-detect';
13
15
  import { assertIsFhevmRuntime } from '../../../runtime/CoreFhevmRuntime-p.js';
14
- // Pure JS file (not compiled by tsc) — provides cross-platform base URL
15
- // for resolving WASM paths. Uses import.meta.url in ESM, __filename in CJS.
16
- import { wasmBaseUrl } from '../../../../wasm/wasmBaseUrl.js';
17
16
  import { loadTfheLib, loadTfheWasmBase64, tfheAssetsWithVersion } from '../../../../wasm/tfhe/loadTfheLib.js';
17
+ import { isomorphicFileUrlExists } from '../../../base/isomorphicFs.js';
18
+
19
+ ////////////////////////////////////////////////////////////////////////////////
20
+
21
+ /**
22
+ * TFHE asset loading rules
23
+ *
24
+ * 1. Asset URL resolution
25
+ * - If `locateFile` is provided:
26
+ * - `URL` return value: that asset has a URL.
27
+ * - `null` / `undefined`: that asset has no URL and must use embedded base64
28
+ * if the selected load path allows it.
29
+ * - Any other value: invalid `locateFile` result.
30
+ * - Each asset is resolved independently; advanced callers may intentionally
31
+ * mix URL and embedded-base64 asset loading.
32
+ * - User-provided URLs are not checked for on-disk existence, even when
33
+ * they use the `file:` protocol. They are explicit caller input and fail
34
+ * later during read/fetch/SHA verification if wrong.
35
+ * - If `locateFile` is not provided:
36
+ * - Node: derive default `file://` URLs as an all-or-none set. If any
37
+ * auto-derived file is missing, clear all TFHE URLs and fall back to
38
+ * embedded base64. This preserves predictable behavior for unexpected
39
+ * bundler/package relocation.
40
+ * - Browser: no asset URL; use embedded base64 paths.
41
+ *
42
+ * 2. WASM module loading
43
+ * - If the WASM asset has a URL: load, SHA-verify, and compile from that URL.
44
+ * - If the WASM asset has no URL: compile from embedded base64.
45
+ * - `wasmAssetLoadMode` does not control WASM module loading.
46
+ *
47
+ * 3. Worker script loading
48
+ * - If single-threaded: no worker is loaded.
49
+ * - If threaded: `wasmAssetLoadMode` controls how the worker script is loaded.
50
+ * - The worker URL only makes a URL-backed worker mode possible; it does not
51
+ * force the worker to use that URL.
52
+ *
53
+ * 4. Worker mode precedence
54
+ * - `embedded-base64`: ignore any worker URL and use embedded worker source.
55
+ * - `verified-blob`: require worker URL, SHA-verify fetched bytes, execute those bytes.
56
+ * - `precheck-direct-url`: require worker URL, SHA precheck, then execute URL directly.
57
+ * - `trusted-direct-url`: require worker URL, execute URL directly without SDK verification.
58
+ * - `auto`: if worker URL exists, try `verified-blob`; on non-SHA failure, fall back
59
+ * to embedded base64. If no worker URL exists, use embedded base64.
60
+ *
61
+ * 5. Failure
62
+ * - Explicit URL worker modes with no worker URL: throw.
63
+ * - SHA mismatch: always throw, never fall back.
64
+ * - Explicit worker-mode runtime failures are surfaced by `startWorkers.js`.
65
+ *
66
+ * 6. Degradation:
67
+ * - Auto-derived Node URLs are best effort only. If either the WASM or worker
68
+ * file is missing on disk, both URLs are cleared and the SDK falls back to the
69
+ * no-URL paths.
70
+ * - With no WASM URL, the WASM module compiles from embedded base64.
71
+ * - With no worker URL, `auto` and `embedded-base64` worker modes use embedded
72
+ * worker source; explicit URL worker modes throw.
73
+ * - If threads are unsupported, unavailable, or configured with zero threads,
74
+ * TFHE runs single-threaded.
75
+ * - If `auto` mode would need a blob/eval worker but blob/eval workers are
76
+ * unavailable, TFHE runs single-threaded.
77
+ * - Single-threaded TFHE never loads a worker; WASM still loads from its resolved
78
+ * URL or embedded base64.
79
+ *
80
+ * 7. Security model:
81
+ * - Mixed transports are allowed for user-resolved assets when chosen explicitly.
82
+ * - External WASM URLs are SHA-verified before compilation.
83
+ * - `verified-blob` verifies and executes the exact worker bytes.
84
+ * - `precheck-direct-url` and `trusted-direct-url` intentionally trust the runtime
85
+ * worker URL fetch semantics described in `startWorkers.js`.
86
+ *
87
+ * Turbopack / relocated package behavior:
88
+ * - In Node, without `locateFile`, the SDK derives default `file://` URLs from
89
+ * the package's wasm base URL.
90
+ * - Some bundlers can relocate/package the JS in a way that makes those derived
91
+ * `file://` URLs point to paths that do not exist on disk.
92
+ * - Passing such URLs to the WASM or worker loaders would fail at runtime instead
93
+ * of using the embedded assets.
94
+ * - To avoid that, auto-derived Node URLs are checked as an all-or-none set before
95
+ * loading: if either the WASM or worker file is missing, both URLs are cleared.
96
+ * - Once cleared, WASM loads from embedded base64 and worker loading follows
97
+ * `wasmAssetLoadMode` with no worker URL available.
98
+ * - User-provided `locateFile` URLs, including `file:` URLs, are not probed here;
99
+ * they are explicit caller input and fail loud later if wrong.
100
+ */
101
+
102
+ ////////////////////////////////////////////////////////////////////////////////
103
+
104
+ function _requiresAssetUrl(wasmAssetLoadMode: WasmAssetLoadMode | undefined): boolean {
105
+ return wasmAssetLoadMode !== undefined && wasmAssetLoadMode !== 'auto' && wasmAssetLoadMode !== 'embedded-base64';
106
+ }
18
107
 
19
108
  ////////////////////////////////////////////////////////////////////////////////
20
109
 
21
110
  // (Node only) Path relative to src/wasm/ where wasmBaseUrl is anchored
22
- const nodeDefaultLocateFile = (file: string): URL => {
111
+ const nodeDefaultLocateFile = async (file: string): Promise<URL> => {
112
+ // Pure JS file (not compiled by tsc) — provides cross-platform base URL
113
+ // for resolving WASM paths. Uses import.meta.url in ESM, __filename in CJS.
114
+ const { wasmBaseUrl } = await import('../../../../wasm/wasmBaseUrl.js');
23
115
  return new URL(`./tfhe/${file}`, wasmBaseUrl);
24
116
  };
25
117
 
@@ -34,20 +126,106 @@ type TfheLibInitAsyncParameters = {
34
126
  readonly num_threads?: number;
35
127
  };
36
128
 
129
+ type TfheAssetResolution = 'user' | 'node' | 'none';
37
130
  type ResolvedTfheAsset = TfheAssetMetadata & {
38
131
  readonly url: URL | undefined;
132
+ readonly resolution: TfheAssetResolution;
39
133
  };
40
134
 
41
- function _resolveTfheAsset(asset: TfheAssetMetadata, locateFile: FhevmRuntimeConfig['locateFile']): ResolvedTfheAsset {
135
+ type ResolvedTfheAssets = {
136
+ readonly wasm: ResolvedTfheAsset;
137
+ readonly worker: ResolvedTfheAsset;
138
+ };
139
+
140
+ async function _resolveSingleTfheAsset(
141
+ asset: TfheAssetMetadata,
142
+ locateFile: FhevmRuntimeConfig['locateFile'],
143
+ ): Promise<ResolvedTfheAsset> {
42
144
  let url: URL | undefined;
145
+ let resolution: TfheAssetResolution = 'none';
43
146
 
44
147
  if (locateFile !== undefined) {
45
- url = locateFile(asset.filename);
148
+ const located = locateFile(asset.filename) as unknown;
149
+ if (located === null || located === undefined) {
150
+ url = undefined;
151
+ } else if (located instanceof URL) {
152
+ url = located;
153
+ } else {
154
+ throw new TypeError(
155
+ `Invalid locateFile result for TFHE asset '${asset.filename}': expected URL, null, or undefined.`,
156
+ );
157
+ }
158
+ resolution = 'user';
46
159
  } else if (!isBrowserLike()) {
47
- url = nodeDefaultLocateFile(asset.localRelativePath);
160
+ url = await nodeDefaultLocateFile(asset.localRelativePath);
161
+ resolution = 'node';
48
162
  }
49
163
 
50
- return Object.freeze({ ...asset, url });
164
+ return Object.freeze({ ...asset, url, resolution });
165
+ }
166
+
167
+ /**
168
+ * Resolves TFHE asset URLs for wasm and worker scripts.
169
+ *
170
+ * With user `locateFile` resolution, each asset is independent: returning a URL
171
+ * opts that asset into URL loading, while returning null/undefined opts that asset
172
+ * into embedded base64 when its selected load path supports it.
173
+ *
174
+ * For `'node'` resolution (auto-derived `file://` URLs), every URL is validated
175
+ * on disk: if any one is missing — e.g. a bundler such as Turbopack relocated the
176
+ * package and the derived `file://ROOT/...` path no longer exists — then ALL URLs
177
+ * are cleared so the whole set falls back to embedded base64 consistently.
178
+ *
179
+ * `'none'` has no URL to validate.
180
+ */
181
+ async function _resolveTfheAssets(
182
+ assets: TfheAssets,
183
+ locateFile: FhevmRuntimeConfig['locateFile'],
184
+ ): Promise<{ readonly wasm: ResolvedTfheAsset; readonly worker: ResolvedTfheAsset }> {
185
+ let wasm = await _resolveSingleTfheAsset(assets.wasm, locateFile);
186
+ let worker = await _resolveSingleTfheAsset(assets.worker, locateFile);
187
+
188
+ // Only auto-derived ('node') file:// URLs need on-disk validation; the mode is
189
+ // shared across all assets, so checking one is enough to know the set's mode.
190
+ if (wasm.resolution === 'node') {
191
+ const allExist = (
192
+ await Promise.all([isomorphicFileUrlExists(wasm.url), isomorphicFileUrlExists(worker.url)])
193
+ ).every(Boolean);
194
+ if (!allExist) {
195
+ wasm = Object.freeze({ ...wasm, url: undefined });
196
+ worker = Object.freeze({ ...worker, url: undefined });
197
+ }
198
+ }
199
+
200
+ return { wasm, worker };
201
+ }
202
+
203
+ /**
204
+ * Emits debug traces describing how the TFHE assets were resolved (user-provided
205
+ * `locateFile`, auto-derived on-disk path, embedded base64, or bundler-relocated
206
+ * fallback). Pure logging — no control flow.
207
+ */
208
+ function _logResolvedTfheAssets(resolvedAssets: ResolvedTfheAssets, logger: FhevmRuntimeConfig['logger']): void {
209
+ const { wasm, worker } = resolvedAssets;
210
+ if (wasm.resolution === 'user') {
211
+ logger?.debug(`resolve tfhe wasm filename using 'locateFile' function: ${wasm.filename} -> url: ${wasm.url}`);
212
+ logger?.debug(`resolve tfhe worker filename using 'locateFile' function: ${worker.filename} -> url: ${worker.url}`);
213
+ } else if (wasm.resolution === 'node') {
214
+ if (wasm.url === undefined) {
215
+ // Auto-derived assets were missing on disk (e.g. a bundler such as Turbopack
216
+ // relocated the package) and were cleared by _resolveTfheAssets -> base64.
217
+ logger?.debug(
218
+ `tfhe auto-derived assets not found on disk (bundler relocation?); using embedded base64 ` +
219
+ `(wasm: ${wasm.localRelativePath}, worker: ${worker.localRelativePath})`,
220
+ );
221
+ } else {
222
+ logger?.debug(`resolve tfhe wasm local path: ${wasm.localRelativePath} -> url: ${wasm.url}`);
223
+ logger?.debug(`resolve tfhe worker local path: ${worker.localRelativePath} -> url: ${worker.url}`);
224
+ }
225
+ } else {
226
+ // 'none': browser zero-config (no 'locateFile', not Node) -> embedded base64.
227
+ logger?.debug(`resolve tfhe assets using embedded base64 (browser, no 'locateFile')`);
228
+ }
51
229
  }
52
230
 
53
231
  ////////////////////////////////////////////////////////////////////////////////
@@ -56,9 +234,8 @@ function _resolveTfheAsset(asset: TfheAssetMetadata, locateFile: FhevmRuntimeCon
56
234
 
57
235
  type ResolvedTfheModuleConfig = {
58
236
  readonly version: TfheVersion;
59
- readonly worker: ResolvedTfheAsset;
237
+ readonly assets: ResolvedTfheAssets;
60
238
  readonly wasmAssetLoadMode: FhevmRuntimeConfig['wasmAssetLoadMode'];
61
- readonly wasm: ResolvedTfheAsset;
62
239
  /* if `true`, then `numberOfThreads` is 0, if `false` then `numberOfThreads` > 0 */
63
240
  readonly singleThread: boolean;
64
241
  readonly numberOfThreads: number;
@@ -102,54 +279,88 @@ async function _getOrResolveTfheModuleConfig(
102
279
  }
103
280
 
104
281
  /**
105
- * @internal
106
- * Resolves user-provided {@link FhevmRuntimeConfig} into a fully resolved config
107
- * (thread count, worker URL, WASM URL). Must be called before WASM initialization.
282
+ * Fails fast on impossible / contradictory TFHE configurations, before any
283
+ * wasm or worker work begins.
284
+ *
285
+ * Only genuinely unsatisfiable configs throw here. Recoverable situations —
286
+ * missing SAB/thread support, or `auto` mode without blob/eval worker support —
287
+ * degrade to single-threaded later. Single-threaded TFHE needs no worker, and
288
+ * wasm still loads from its resolved URL or embedded base64. Do not add
289
+ * degradable cases to this function.
108
290
  */
109
- async function _resolveTfheModuleConfig(
110
- parameters: FhevmRuntimeConfig,
111
- version: TfheVersion,
112
- ): Promise<ResolvedTfheModuleConfig> {
113
- const {
114
- locateFile,
115
- wasmAssetLoadMode,
116
- singleThread: singleThreadConfig,
117
- numberOfThreads: numberOfThreadsConfig,
118
- } = parameters;
291
+ function _assertSatisfiableTfheConfig(resolvedAssets: ResolvedTfheAssets, parameters: FhevmRuntimeConfig): void {
292
+ const { wasmAssetLoadMode, numberOfThreads } = parameters;
293
+ const { wasm, worker } = resolvedAssets;
119
294
 
120
- let singleThread = false;
121
- if (singleThreadConfig !== undefined) {
122
- singleThread = singleThreadConfig;
295
+ if (wasm.resolution !== worker.resolution) {
296
+ // internal error
297
+ throw new Error('Internal error');
123
298
  }
124
299
 
125
- const canUseBlob = await isBlobWorkerSupported();
300
+ // (1) Auto-derived Node URLs must remain all-or-none. User `locateFile`
301
+ // resolution may intentionally mix URL and embedded-base64 assets, but a
302
+ // partial Node file set means the package/bundler layout is inconsistent.
303
+ if (wasm.resolution === 'node') {
304
+ if ((wasm.url === undefined) !== (worker.url === undefined)) {
305
+ throw new Error(
306
+ `Inconsistent auto-derived TFHE asset URLs: Node resolution must resolve both the wasm and worker assets, or neither ` +
307
+ `(wasm: ${wasm.url ? 'url' : 'none'}, worker: ${worker.url ? 'url' : 'none'}).`,
308
+ );
309
+ }
310
+ }
126
311
 
127
- const assets = tfheAssetsWithVersion(version);
128
- const wasm = _resolveTfheAsset(assets.wasm, locateFile);
129
- const worker = _resolveTfheAsset(assets.worker, locateFile);
312
+ // (2) A URL-requiring worker mode (verified-blob / precheck-direct-url /
313
+ // trusted-direct-url) was selected, but no worker URL is available.
314
+ // We refuse to silently downgrade an explicit URL/verification choice to base64.
315
+ if (worker.url === undefined && _requiresAssetUrl(wasmAssetLoadMode)) {
316
+ throw new Error(
317
+ `wasmAssetLoadMode '${wasmAssetLoadMode}' requires a resolvable worker URL, but none is available. ` +
318
+ `Use 'auto' or 'embedded-base64', or provide a worker URL via 'locateFile'.`,
319
+ );
320
+ }
130
321
 
131
- if (locateFile !== undefined) {
132
- parameters.logger?.debug(`resolve tfhe wasm filename: ${wasm.filename} -> url: ${wasm.url}`);
133
- parameters.logger?.debug(`resolve tfhe worker filename: ${worker.filename} -> url: ${worker.url}`);
134
- } else {
135
- /*
136
- if run in Node only, use defaultLocateFile!
137
- */
138
- if (isBrowserLike()) {
139
- if (!canUseBlob) {
140
- throw new Error('Missing locate file function');
141
- }
142
- } else {
143
- parameters.logger?.debug(`resolve tfhe wasm local path: ${wasm.localRelativePath} -> url: ${wasm.url}`);
144
- parameters.logger?.debug(`resolve tfhe worker local path: ${worker.localRelativePath} -> url: ${worker.url}`);
145
- }
322
+ // (3) Invalid thread count: must be a non-negative integer when provided.
323
+ // (Negative / NaN would otherwise be silently coerced to single-threaded,
324
+ // hiding the caller's mistake.)
325
+ if (numberOfThreads !== undefined && (!Number.isInteger(numberOfThreads) || numberOfThreads < 0)) {
326
+ throw new Error(`numberOfThreads must be a non-negative integer, received: ${String(numberOfThreads)}`);
146
327
  }
328
+ }
329
+
330
+ ////////////////////////////////////////////////////////////////////////////////
147
331
 
148
- let numberOfThreads: number | undefined;
332
+ type ResolvedThreadConfig = {
333
+ readonly singleThread: boolean;
334
+ readonly numberOfThreads: number;
335
+ readonly supportsThreads: boolean | undefined;
336
+ };
337
+
338
+ /**
339
+ * Resolves the effective threading config. Degrades to single-threaded when
340
+ * multi-threading is requested but cannot run — no SharedArrayBuffer/COOP-COEP
341
+ * support, or no way to spawn a worker. Never throws: single-threaded always works
342
+ * (it needs no worker, and the wasm still loads via URL or embedded base64).
343
+ */
344
+ async function _resolveThreadConfig(args: {
345
+ readonly preferredSingleThread: boolean;
346
+ readonly numberOfThreadsConfig: number | undefined;
347
+ readonly wasmAssetLoadMode: WasmAssetLoadMode;
348
+ readonly canUseBlob: boolean;
349
+ readonly logger: FhevmRuntimeConfig['logger'];
350
+ }): Promise<ResolvedThreadConfig> {
351
+ const { preferredSingleThread, numberOfThreadsConfig, wasmAssetLoadMode, canUseBlob, logger } = args;
352
+
353
+ let singleThread = preferredSingleThread;
354
+ let numberOfThreads = 0;
149
355
  let supportsThreads: boolean | undefined;
150
356
 
151
357
  if (!singleThread) {
152
- numberOfThreads = numberOfThreadsConfig ?? navigator.hardwareConcurrency; // Node 21+
358
+ // `navigator` is absent in some edge runtimes (and Node <21); guard it so a
359
+ // missing global degrades to single-threaded (0) instead of a ReferenceError.
360
+ // This single-threaded fallback is also the only viable mode on edge anyway:
361
+ // Cloudflare Workers and Vercel Edge support neither Web Workers (`new Worker`)
362
+ // nor `node:worker_threads`, so the worker pool could not be spawned there.
363
+ numberOfThreads = numberOfThreadsConfig ?? (typeof navigator !== 'undefined' ? navigator.hardwareConcurrency : 0);
153
364
 
154
365
  if (numberOfThreads > 0) {
155
366
  // SharedArrayBuffer requires COOP/COEP headers in browsers.
@@ -163,28 +374,115 @@ async function _resolveTfheModuleConfig(
163
374
  );
164
375
  singleThread = true;
165
376
  numberOfThreads = 0;
377
+ } else if (!canUseBlob && wasmAssetLoadMode === 'auto') {
378
+ // Threads are supported, but the selected mode spawns its worker from code
379
+ // (embedded-base64 / verified-blob / auto — blob in browser, eval in Node),
380
+ // and blob/eval workers are unavailable here. The direct-url modes use
381
+ // `new Worker(url)` and don't need blob support, so they're exempt.
382
+ // Degrade to single-threaded (single-threaded TFHE needs no worker).
383
+ logger?.warn?.(
384
+ `Cannot spawn a '${wasmAssetLoadMode}' worker (blob/eval workers unavailable); running single-threaded.`,
385
+ );
386
+ singleThread = true;
387
+ numberOfThreads = 0;
166
388
  }
167
389
  } else {
168
390
  singleThread = true;
169
391
  numberOfThreads = 0;
170
392
  }
171
- } else {
172
- numberOfThreads = 0;
173
393
  }
174
394
 
395
+ return { singleThread, numberOfThreads, supportsThreads };
396
+ }
397
+
398
+ /**
399
+ * @internal
400
+ * Resolves user-provided {@link FhevmRuntimeConfig} into a fully resolved config
401
+ * (thread count, worker URL, WASM URL). Must be called before WASM initialization.
402
+ */
403
+ async function _resolveTfheModuleConfig(
404
+ parameters: FhevmRuntimeConfig,
405
+ version: TfheVersion,
406
+ ): Promise<ResolvedTfheModuleConfig> {
407
+ const {
408
+ locateFile,
409
+ wasmAssetLoadMode: requestedWasmAssetLoadMode,
410
+ singleThread: preferredSingleThread,
411
+ numberOfThreads: numberOfThreadsConfig,
412
+ } = parameters;
413
+
414
+ const wasmAssetLoadMode = requestedWasmAssetLoadMode ?? 'auto';
415
+ const canUseBlob = await isBlobWorkerSupported();
416
+
417
+ const assets = tfheAssetsWithVersion(version);
418
+
419
+ const resolvedAssets = await _resolveTfheAssets(assets, locateFile);
420
+
421
+ // ── TFHE asset resolution & degradation rules ───────────────────────────────
422
+ //
423
+ // POLICY: user-resolved assets may intentionally mix transports (e.g. URL
424
+ // wasm + embedded worker). Auto-derived Node assets remain all-or-none because
425
+ // missing local files are unexpected and usually mean bundler/package relocation.
426
+ //
427
+ // Asset URL resolution:
428
+ //
429
+ // locateFile runtime / on-disk resolution asset url policy
430
+ // ---------- --------------------- ---------- -------------- --------------------------
431
+ // provided any 'user' per asset caller controls each asset
432
+ // none Node, files present 'node' file://… all TFHE URLs kept
433
+ // none Node, files missing * 'node' undefined all TFHE URLs cleared
434
+ // none browser 'none' undefined embedded base64
435
+ // * e.g. a bundler (Turbopack) relocated the package; URLs cleared by _resolveTfheAssets.
436
+ //
437
+ // Worker load mode (wasmAssetLoadMode) requirements:
438
+ //
439
+ // mode needs URL? needs blob/eval worker (canUseBlob)?
440
+ // ------------------- ---------- ------------------------------------
441
+ // embedded-base64 no yes
442
+ // verified-blob yes yes
443
+ // auto no yes (verified-blob if URL, else embedded)
444
+ // precheck-direct-url yes no (new Worker(url))
445
+ // trusted-direct-url yes no (new Worker(url))
446
+ //
447
+ // Failure / degradation (in order):
448
+ // 1. explicit URL mode but no URL is available -> throw (unsatisfiable config)
449
+ // 2. threads requested but unsupported (no SAB) -> degrade to single-threaded
450
+ // 3. auto mode cannot spawn blob/eval workers -> degrade to single-threaded
451
+ //
452
+ // Explicit worker modes are not downgraded here:
453
+ // startWorkers.js owns their worker-loading behavior and surfaces their failures.
454
+ // Single-threaded never needs a worker; wasm still loads (URL or embedded base64).
455
+
456
+ // Early validation: throw on impossible/contradictory configs. Recoverable
457
+ // cases (no worker source, no thread support) degrade later — they are NOT here.
458
+ _assertSatisfiableTfheConfig(resolvedAssets, parameters);
459
+
460
+ _logResolvedTfheAssets(resolvedAssets, parameters.logger);
461
+
462
+ const { singleThread, numberOfThreads, supportsThreads } = await _resolveThreadConfig({
463
+ preferredSingleThread: preferredSingleThread ?? false,
464
+ numberOfThreadsConfig,
465
+ wasmAssetLoadMode,
466
+ canUseBlob,
467
+ logger: parameters.logger,
468
+ });
469
+
175
470
  const tfheLib = await loadTfheLib(version);
471
+
176
472
  tfheLib.setWorkerUrlConfig({
177
- workerUrl: worker.url,
473
+ workerUrl: resolvedAssets.worker.url,
178
474
  wasmAssetLoadMode,
475
+ // Single source of truth for browser-vs-Node, resolved on the main thread
476
+ // (robust to bundler `process` shims) — the worker bootstrap no longer detects it.
477
+ isBrowserLike: isBrowserLike(),
179
478
  logger: parameters.logger,
180
479
  });
181
480
 
182
481
  const cfg = {
183
482
  version,
184
483
  numberOfThreads,
185
- worker,
484
+ assets: resolvedAssets,
186
485
  wasmAssetLoadMode,
187
- wasm,
188
486
  singleThread,
189
487
  logger: parameters.logger,
190
488
  supportsThreads,
@@ -270,20 +568,27 @@ export async function initTfheModule(runtime: FhevmRuntime, parameters: InitTfhe
270
568
  return cachedTfheModulePromise;
271
569
  }
272
570
 
273
- async function _initTfheModule(cfg: ResolvedTfheModuleConfig): Promise<TfheLibApi> {
274
- const tfheLib = await loadTfheLib(cfg.version);
275
-
276
- // Compile WASM module (see matrix in types.ts)
571
+ async function _compileWasmModule(cfg: ResolvedTfheModuleConfig): Promise<WebAssembly.Module> {
277
572
  let wasmModule;
278
- if (cfg.wasm.url !== undefined) {
279
- cfg.logger?.debug(`compile verified wasm at: ${cfg.wasm.url}`);
280
- wasmModule = await isomorphicCompileVerifiedWasm(cfg.wasm.url, cfg.wasm.sha256);
573
+
574
+ if (cfg.assets.wasm.url !== undefined) {
575
+ cfg.logger?.debug(`compile verified wasm at: ${cfg.assets.wasm.url}`);
576
+ wasmModule = await isomorphicCompileVerifiedWasm(cfg.assets.wasm.url, cfg.assets.wasm.sha256);
281
577
  } else {
282
578
  const { tfheWasmBase64, tfheWasmBase64CompressionFormat } = await loadTfheWasmBase64(cfg.version);
283
579
  cfg.logger?.debug(`compile wasm from embedded base64 (compression:${tfheWasmBase64CompressionFormat ?? 'none'})`);
284
580
  wasmModule = await isomorphicCompileWasmFromBase64(tfheWasmBase64, tfheWasmBase64CompressionFormat);
285
581
  }
286
582
 
583
+ return wasmModule;
584
+ }
585
+
586
+ async function _initTfheModule(cfg: ResolvedTfheModuleConfig): Promise<TfheLibApi> {
587
+ const tfheLib = await loadTfheLib(cfg.version);
588
+
589
+ // 1. Compile WASM module
590
+ const wasmModule = await _compileWasmModule(cfg);
591
+
287
592
  const input: TfheLibInitAsyncParameters = { module_or_path: wasmModule };
288
593
 
289
594
  // 2. Load and instantiate the TFHE WASM binary
@@ -308,10 +613,10 @@ async function _initTfheModule(cfg: ResolvedTfheModuleConfig): Promise<TfheLibAp
308
613
  moduleInfoByVersion.set(
309
614
  cfg.version,
310
615
  Object.freeze({
311
- wasmUrl: cfg.wasm.url ? new URL(cfg.wasm.url) : undefined,
616
+ wasmUrl: cfg.assets.wasm.url ? new URL(cfg.assets.wasm.url) : undefined,
312
617
  version: wasmInfo.version,
313
618
  name: wasmInfo.name,
314
- workerUrl: cfg.worker.url ? new URL(cfg.worker.url) : undefined,
619
+ workerUrl: cfg.assets.worker.url ? new URL(cfg.assets.worker.url) : undefined,
315
620
  numberOfThreads: cfg.singleThread ? 0 : cfg.numberOfThreads,
316
621
  threadsAvailable: cfg.supportsThreads,
317
622
  memory,
@@ -87,8 +87,8 @@ const HYPER_WASM_SOLVER_CONFIG = {
87
87
  // pubKeyCrs.version <= 1.5.x (ex: mainnet 1.4.0-alpha.3)
88
88
  pubKeyCrs: { version: '1.6.0', comparator: 'lt' },
89
89
  tfhe: {
90
- canonical: '1.6.1',
91
- compatible: ['1.5.3', '1.6.1'],
90
+ canonical: '1.6.2',
91
+ compatible: ['1.5.3', '1.6.2'],
92
92
  },
93
93
  kms: {
94
94
  canonical: '0.13.20-0',
@@ -101,8 +101,8 @@ const HYPER_WASM_SOLVER_CONFIG = {
101
101
  // pubKeyCrs.version >= 1.6.0 (ex: localstack_v13)
102
102
  pubKeyCrs: { version: '1.6.0', comparator: 'ge' },
103
103
  tfhe: {
104
- canonical: '1.6.1',
105
- compatible: ['1.6.1'],
104
+ canonical: '1.6.2',
105
+ compatible: ['1.6.2'],
106
106
  },
107
107
  kms: {
108
108
  canonical: '0.13.20-0',
@@ -5,5 +5,5 @@ import { verifyFhevmRuntime } from './CoreFhevmRuntime-p.js';
5
5
  export async function initFhevmEncryptRuntime(runtime: FhevmRuntime, ownerToken: symbol): Promise<void> {
6
6
  verifyFhevmRuntime(runtime, ownerToken);
7
7
  const encryptRuntime = runtime.extend(encryptModule);
8
- await encryptRuntime.encrypt.initTfheModule({ tfheVersion: '1.6.1' });
8
+ await encryptRuntime.encrypt.initTfheModule({ tfheVersion: '1.6.2' });
9
9
  }
@@ -8,6 +8,6 @@ export async function initFhevmRuntime(runtime: FhevmRuntime, ownerToken: symbol
8
8
  const fullRuntime = runtime.extend(decryptModule).extend(encryptModule);
9
9
  await Promise.all([
10
10
  fullRuntime.decrypt.initTkmsModule({ tkmsVersion: '0.13.20-0' }),
11
- fullRuntime.encrypt.initTfheModule({ tfheVersion: '1.6.1' }),
11
+ fullRuntime.encrypt.initTfheModule({ tfheVersion: '1.6.2' }),
12
12
  ]);
13
13
  }
@@ -1,3 +1,61 @@
1
+ /*
2
+ * verified-blob:
3
+ * --------------
4
+ * Creates a worker from the configured URL after SHA-256 verification.
5
+ * 1. Reuse cached verified bytes.
6
+ * 2. Execute those exact bytes as a Blob worker in browsers.
7
+ * 3. Execute those exact bytes as an eval worker in Node.
8
+ *
9
+ * - Transport: url
10
+ * - Blob: yes
11
+ * - SHA256: yes
12
+ *
13
+ * precheck-direct-url:
14
+ * --------------------
15
+ * Creates a worker by passing the configured URL directly to the runtime, after a pre-flight SHA-256 probe.
16
+ *
17
+ * IMPORTANT: this is NOT an integrity check. The SDK fetches the URL once to validate
18
+ * the hash, then hands the URL to the runtime, which fetches it a SECOND time and
19
+ * executes those bytes. The two fetches are independent — the executed bytes are
20
+ * never verified. Use only for fail-fast on misconfigured URLs / build mismatches.
21
+ *
22
+ * For an actual integrity guarantee, use `verified-blob` (requires CSP allowing blob: workers).
23
+ *
24
+ * 1. Fetch the URL and verify its SHA-256 against __TFHE_WORKER_URL_SHA256_JSON__ — fails fast on mismatch.
25
+ * 2. Discard the verified bytes.
26
+ * 3. Let the runtime fetch the same URL again and execute it (no verification on this fetch).
27
+ *
28
+ * - Transport: url
29
+ * - Blob: no
30
+ * - SHA256: yes
31
+ *
32
+ * trusted-direct-url:
33
+ * -------------------
34
+ * Creates a worker by passing the configured URL directly to the runtime.
35
+ * 1. Require a configured worker URL.
36
+ * 2. Do not perform SDK byte verification.
37
+ * 3. Let the browser or Node runtime load and execute the URL directly.
38
+ *
39
+ * - Transport: url
40
+ * - Blob: no
41
+ * - SHA256: no
42
+ *
43
+ * embedded-base64:
44
+ * ----------------
45
+ * Creates a worker from the SDK-embedded base64 worker source.
46
+ * 1. Read the base64-encoded JavaScript source baked into this module.
47
+ * 2. Decode into a Blob URL and create a module Worker in browsers.
48
+ * 3. Decode into UTF-8 JavaScript and create a worker_threads eval Worker in Node.
49
+ *
50
+ * - Transport: base64
51
+ * - Blob: yes
52
+ * - SHA256: no
53
+ *
54
+ * auto:
55
+ * -----
56
+ * if workerUrl is defined, try it using `verified-blob`.
57
+ * if workerUrl failed or is undefined go for `embedded-base64`
58
+ */
1
59
  export type WasmAssetLoadMode =
2
60
  | 'embedded-base64'
3
61
  | 'verified-blob'
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@fhevm/sdk",
3
3
  "description": "TypeScript Interface for FHEVM",
4
- "version": "1.1.0-alpha.5",
4
+ "version": "1.1.0-alpha.6",
5
5
  "type": "module",
6
6
  "main": "./_cjs/index.js",
7
7
  "module": "./_esm/index.js",