Skip to content

Commit 69920ee

Browse files
committed
add noble as QuickJS compatible crypto lib
1 parent 8198f2b commit 69920ee

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed

src/content/cre/concepts/typescript-wasm-runtime.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ Javy uses [QuickJS](https://bellard.org/quickjs), a lightweight JavaScript engin
3434

3535
Not all Node.js built-in modules are available. For example, `node:crypto` is not supported. Before using third-party NPM packages, verify they don't rely on unsupported Node.js APIs.
3636

37+
{/* prettier-ignore */}
38+
<Aside type="tip" title="Cryptography libraries">
39+
If you need cryptographic functions, <a href="https://paulmillr.com/noble/" target="_blank" rel="noopener noreferrer">Noble</a> is a popular JavaScript cryptography library with minimal dependencies that works well with QuickJS. Always verify any third-party library in simulation before deploying.
40+
</Aside>
41+
3742
<Aside type="note" title="Note on async/await with SDK capabilities">
3843
While JavaScript `Promise` and `async/await` are supported by QuickJS, **SDK capabilities do not use them**. The CRE
3944
TypeScript SDK uses a custom `.result()` pattern instead. See the [Core SDK

src/content/cre/getting-started/before-you-build-ts.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ Your TypeScript code compiles to WebAssembly and runs in a QuickJS environment,
2525
1. Check if it relies on Node.js built-in modules
2626
1. Test with `cre workflow simulate` — simulation uses the same WASM environment as production, so compatibility issues surface immediately
2727

28+
{/* prettier-ignore */}
29+
<Aside type="tip" title="Cryptography libraries">
30+
If you need cryptographic functions, <a href="https://paulmillr.com/noble/" target="_blank" rel="noopener noreferrer">Noble</a> is a popular JavaScript cryptography library that works well with QuickJS. Always verify any third-party library in simulation before deploying.
31+
</Aside>
32+
2833
{/* prettier-ignore */}
2934
<Aside type="tip" title="Learn more">
3035
See [TypeScript Runtime Environment](/cre/concepts/typescript-wasm-runtime) for details on QuickJS compatibility and how to [verify library support](/cre/concepts/typescript-wasm-runtime#checking-library-compatibility).

src/content/cre/llms-full-ts.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6165,6 +6165,11 @@ Javy uses [QuickJS](https://bellard.org/quickjs), a lightweight JavaScript engin
61656165

61666166
Not all Node.js built-in modules are available. For example, `node:crypto` is not supported. Before using third-party NPM packages, verify they don't rely on unsupported Node.js APIs.
61676167

6168+
6169+
<Aside type="tip" title="Cryptography libraries">
6170+
If you need cryptographic functions, <a href="https://paulmillr.com/noble/" target="_blank" rel="noopener noreferrer">Noble</a> is a popular JavaScript cryptography library with minimal dependencies that works well with QuickJS. Always verify any third-party library in simulation before deploying.
6171+
</Aside>
6172+
61686173
<Aside type="note" title="Note on async/await with SDK capabilities">
61696174
While JavaScript `Promise` and `async/await` are supported by QuickJS, **SDK capabilities do not use them**. The CRE
61706175
TypeScript SDK uses a custom `.result()` pattern instead. See the [Core SDK
@@ -7671,6 +7676,11 @@ Your TypeScript code compiles to WebAssembly and runs in a QuickJS environment,
76717676
2. Test with `cre workflow simulate` — simulation uses the same WASM environment as production, so compatibility issues surface immediately
76727677

76737678

7679+
<Aside type="tip" title="Cryptography libraries">
7680+
If you need cryptographic functions, <a href="https://paulmillr.com/noble/" target="_blank" rel="noopener noreferrer">Noble</a> is a popular JavaScript cryptography library that works well with QuickJS. Always verify any third-party library in simulation before deploying.
7681+
</Aside>
7682+
7683+
76747684
<Aside type="tip" title="Learn more">
76757685
See [TypeScript Runtime Environment](/cre/concepts/typescript-wasm-runtime) for details on QuickJS compatibility and how to [verify library support](/cre/concepts/typescript-wasm-runtime#checking-library-compatibility).
76767686
</Aside>

0 commit comments

Comments
 (0)