@chainlink/cre-sdk 1.1.3-alpha.1 → 1.1.3

package/README.md

@@ -8,7 +8,6 @@ The Chainlink Runtime Environment (CRE) SDK for TypeScript enables developers to
 - [Examples](#examples)
 - [Simulate locally with CRE CLI](#simulate-locally-with-cre-cli)
 - [Installation](#installation)
-- [Runtime Compatibility Constraints](#runtime-compatibility-constraints)
 - [Core Concepts](#core-concepts)
   - [Workflows](#workflows)
   - [Runtime Modes](#runtime-modes)
@@ -48,20 +47,10 @@ This package must be used along with the [CRE CLI tool](https://github.com/smart
 
 ## Prerequisites
 
-1. the [bun runtime](https://bun.com/) for local tooling and workflow compilation.
+1. the [bun runtime](https://bun.com/). The wasm compilation currently is only supported by the bun runtime which has near-complete NodeJS compatibility.
 
 2. the [CRE CLI tool](https://github.com/smartcontractkit/cre-cli) installed.
 
-## Runtime Compatibility Constraints
-
-CRE workflows are compiled to WASM and executed through Javy (QuickJS). This is **not** a full Node.js runtime.
-
-- Node built-ins like `node:fs`, `node:crypto`, `node:http`, `node:net`, etc. are not supported in workflows.
-- Browser globals like `fetch`, `window`, and `setTimeout` are also not available in workflow runtime.
-- `cre compile:workflow` / `cre-compile` now validates workflow source and fails fast when unsupported APIs are used.
-
-Use CRE capabilities (for example, `cre.capabilities.HTTPClient`) instead of direct Node/browser APIs.
-
 ## Getting Started
 
 We recommend you consult the [getting started docs](https://docs.chain.link/cre/getting-started/cli-installation) and install the CRE CLI.

package/dist/index.d.ts

@@ -1,4 +1 @@
-/// <reference types="./sdk/types/global" />
-/// <reference types="./sdk/types/restricted-apis" />
-/// <reference types="./sdk/types/restricted-node-modules" />
 export * from './sdk';

package/dist/sdk/types/global.d.ts

@@ -1,8 +1,5 @@
-// Global type declarations for the CRE SDK runtime.
-// These are the methods and globals exposed by the Host to the Guest.
-
-type ExistingGlobal<K extends PropertyKey, Fallback> =
-	typeof globalThis extends Record<K, infer T> ? T : Fallback
+// Global type declarations for the CRE SDK runtime
+// Those are the methods that the Host exposes to the Guest.
 
 /**
  * Host functions exposed by the CRE runtime to WASM guests
@@ -81,106 +78,6 @@ declare global {
 	 * @returns Unix timestamp in milliseconds
 	 */
 	function now(): number
-
-	/**
-	 * Console API available in the QuickJS runtime
-	 */
-	type CreConsole = {
-		log(...args: unknown[]): void
-		warn(...args: unknown[]): void
-		error(...args: unknown[]): void
-		info(...args: unknown[]): void
-		debug(...args: unknown[]): void
-	}
-	var console: ExistingGlobal<'console', CreConsole>
-
-	/**
-	 * TextEncoder/TextDecoder APIs available via Javy's text_encoding support
-	 */
-	interface CreTextEncoderEncodeIntoResult {
-		read: number
-		written: number
-	}
-
-	interface CreTextEncoder {
-		readonly encoding: string
-		encode(input?: string): Uint8Array
-		encodeInto(input: string, dest: Uint8Array): CreTextEncoderEncodeIntoResult
-	}
-	var TextEncoder: ExistingGlobal<
-		'TextEncoder',
-		{ prototype: CreTextEncoder; new (): CreTextEncoder }
-	>
-
-	interface CreTextDecoder {
-		readonly encoding: string
-		readonly fatal: boolean
-		readonly ignoreBOM: boolean
-		decode(input?: ArrayBuffer | ArrayBufferView, options?: { stream?: boolean }): string
-	}
-	var TextDecoder: ExistingGlobal<
-		'TextDecoder',
-		{
-			prototype: CreTextDecoder
-			new (label?: string, options?: { fatal?: boolean; ignoreBOM?: boolean }): CreTextDecoder
-		}
-	>
-
-	/**
-	 * Base64 encoding/decoding — exposed via prepareRuntime() from node:buffer
-	 */
-	function atob(encodedData: string): string
-	function btoa(stringToEncode: string): string
-
-	/**
-	 * URL and URLSearchParams — exposed via prepareRuntime() from node:url
-	 */
-	interface CreURLSearchParams {
-		append(name: string, value: string): void
-		delete(name: string): void
-		get(name: string): string | null
-		getAll(name: string): string[]
-		has(name: string): boolean
-		set(name: string, value: string): void
-		sort(): void
-		toString(): string
-		forEach(callback: (value: string, key: string, parent: CreURLSearchParams) => void): void
-		entries(): IterableIterator<[string, string]>
-		keys(): IterableIterator<string>
-		values(): IterableIterator<string>
-		[Symbol.iterator](): IterableIterator<[string, string]>
-		readonly size: number
-	}
-	var URLSearchParams: ExistingGlobal<
-		'URLSearchParams',
-		{
-			prototype: CreURLSearchParams
-			new (
-				init?: string | Record<string, string> | [string, string][] | CreURLSearchParams,
-			): CreURLSearchParams
-		}
-	>
-
-	interface CreURL {
-		hash: string
-		host: string
-		hostname: string
-		href: string
-		readonly origin: string
-		password: string
-		pathname: string
-		port: string
-		protocol: string
-		search: string
-		readonly searchParams: CreURLSearchParams
-		username: string
-		toString(): string
-		toJSON(): string
-	}
-	var URL: ExistingGlobal<
-		'URL',
-		{ prototype: CreURL; new (url: string, base?: string | CreURL): CreURL }
-	>
 }
 
 export {}

package/dist/sdk/types/restricted-apis.d.ts

@@ -1,22 +1,27 @@
 declare global {
-	/**
-	 * @deprecated fetch is not available in CRE WASM workflows.
-	 * Use cre.capabilities.HTTPClient instead.
-	 * @see https://docs.chain.link/cre/concepts/typescript-wasm-runtime
-	 */
-	function fetch(_notAvailable: never): never
-
-	/**
-	 * @deprecated setTimeout is not available in CRE WASM workflows. Use cre.capabilities.CronCapability for scheduling.
-	 * @see https://docs.chain.link/cre/concepts/typescript-wasm-runtime
-	 */
-	function setTimeout(_notAvailable: never, ..._args: never[]): never
-
-	/**
-	 * @deprecated setInterval is not available in CRE WASM workflows. Use cre.capabilities.CronCapability for scheduling.
-	 * @see https://docs.chain.link/cre/concepts/typescript-wasm-runtime
-	 */
-	function setInterval(_notAvailable: never, ..._args: never[]): never
+	/** @deprecated fetch is not available in CRE WASM workflows. Use cre.capabilities.HTTPClient instead. */
+	const fetch: never
+
+	/** @deprecated window is not available in CRE WASM workflows. */
+	const window: never
+
+	/** @deprecated document is not available in CRE WASM workflows. */
+	const document: never
+
+	/** @deprecated XMLHttpRequest is not available in CRE WASM workflows. Use cre.capabilities.HTTPClient instead. */
+	const XMLHttpRequest: never
+
+	/** @deprecated localStorage is not available in CRE WASM workflows. */
+	const localStorage: never
+
+	/** @deprecated sessionStorage is not available in CRE WASM workflows. */
+	const sessionStorage: never
+
+	/** @deprecated setTimeout is not available in CRE WASM workflows. Use cre.capabilities.CronCapability for scheduling. */
+	const setTimeout: never
+
+	/** @deprecated setInterval is not available in CRE WASM workflows. Use cre.capabilities.CronCapability for scheduling. */
+	const setInterval: never
 }
 
 export {}

package/dist/sdk/utils/prepare-runtime.d.ts

@@ -1,6 +1,6 @@
 /**
  * This function is used to prepare the runtime for the SDK to work.
  * It should be called as a part of SDK initialization.
- * It exposes Node.js APIs in global namespace, so they can be bundled and used in workflow code.
+ * It exposes NodeJS Buffer in global namespace, so it can be bundled and used in workflow code.
  */
 export declare const prepareRuntime: () => void;

package/dist/sdk/utils/prepare-runtime.js

@@ -1,16 +1,9 @@
-import { atob, Buffer, btoa } from 'node:buffer';
-import { URL, URLSearchParams } from 'node:url';
+import { Buffer } from 'node:buffer';
 /**
  * This function is used to prepare the runtime for the SDK to work.
  * It should be called as a part of SDK initialization.
- * It exposes Node.js APIs in global namespace, so they can be bundled and used in workflow code.
+ * It exposes NodeJS Buffer in global namespace, so it can be bundled and used in workflow code.
  */
 export const prepareRuntime = () => {
     globalThis.Buffer = Buffer;
-    globalThis.atob = atob;
-    globalThis.btoa = btoa;
-    // node:url constructor types are slightly narrower than lib.dom/global types.
-    // Runtime behavior is compatible; cast to the global constructor shapes.
-    globalThis.URL = URL;
-    globalThis.URLSearchParams = URLSearchParams;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@chainlink/cre-sdk",
-	"version": "1.1.3-alpha.1",
+	"version": "1.1.3",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/scripts/run.ts

@@ -37,11 +37,7 @@ const main = async () => {
 			process.exit(1)
 		}
 	} catch (error) {
-		if (error instanceof Error && error.name === 'WorkflowRuntimeCompatibilityError') {
-			console.error(error.message)
-		} else {
-			console.error(`Failed to run script ${scriptName}:`, error)
-		}
+		console.error(`Failed to load script ${scriptName}:`, error)
 		process.exit(1)
 	}
 }

package/scripts/src/build-types.ts

@@ -1,5 +1,5 @@
 import { glob } from 'fast-glob'
-import { copyFile, mkdir, readFile, writeFile } from 'fs/promises'
+import { copyFile, mkdir } from 'fs/promises'
 import { join } from 'path'
 
 const buildTypes = async () => {
@@ -28,36 +28,6 @@ const buildTypes = async () => {
 	}
 
 	console.log(`✅ Copied ${typeFiles.length} type definition file(s) to dist/sdk/types`)
-
-	// Prepend triple-slash references to dist/index.d.ts so consumers pick up
-	// global type augmentations (e.g. restricted-apis.d.ts) automatically.
-	// tsc strips these from the emitted .d.ts, so we add them back here.
-	const indexDts = join(packageRoot, 'dist/index.d.ts')
-	const sourceIndex = join(packageRoot, 'src/index.ts')
-	const sourceContent = await readFile(sourceIndex, 'utf-8')
-
-	const refsFromSource = sourceContent
-		.split('\n')
-		.filter((line) => line.startsWith('/// <reference types='))
-
-	// Add references for consumer-only type declarations that cannot be in src/index.ts
-	// because they would break the SDK's own scripts/tests (which legitimately use Node.js APIs).
-	const consumerOnlyRefs = ['/// <reference types="./sdk/types/restricted-node-modules" />']
-
-	const tripleSlashRefs = [...refsFromSource, ...consumerOnlyRefs].join('\n')
-
-	if (tripleSlashRefs) {
-		const indexContent = await readFile(indexDts, 'utf-8')
-		// Strip any existing triple-slash references from the top of the file
-		// so that re-running build-types is idempotent.
-		const withoutExistingRefs = indexContent
-			.split('\n')
-			.filter((line) => !line.startsWith('/// <reference types='))
-			.join('\n')
-			.replace(/^\n+/, '') // trim leading blank lines left after stripping
-		await writeFile(indexDts, `${tripleSlashRefs}\n${withoutExistingRefs}`)
-		console.log('✅ Added triple-slash references to dist/index.d.ts')
-	}
 }
 
 export const main = buildTypes

package/scripts/src/compile-to-js.ts

@@ -2,7 +2,6 @@ import { existsSync, readFileSync, unlinkSync, writeFileSync } from 'node:fs'
 import { mkdir } from 'node:fs/promises'
 import path from 'node:path'
 import { $ } from 'bun'
-import { assertWorkflowRuntimeCompatibility } from './validate-workflow-runtime-compat'
 import { wrapWorkflowCode } from './workflow-wrapper'
 
 export const main = async (tsFilePath?: string, outputFilePath?: string) => {
@@ -20,7 +19,6 @@ export const main = async (tsFilePath?: string, outputFilePath?: string) => {
 	}
 
 	const resolvedInput = path.resolve(inputPath)
-	assertWorkflowRuntimeCompatibility(resolvedInput)
 	console.info(`📁 Using input file: ${resolvedInput}`)
 
 	// If no explicit output path → same dir, swap extension to .js