@chainlink/cre-sdk 0.0.5-alpha → 0.0.7-alpha

package/dist/index.d.ts

@@ -1,5 +1 @@
 export * from './sdk';
-export * from './sdk/runtime';
-export * from './sdk/utils';
-export * from './sdk/utils/capabilities/http/http-helpers';
-export * from './sdk/wasm';

package/dist/index.js

@@ -1,7 +1,3 @@
 /// <reference types="./sdk/types/global" />
+/// <reference types="./sdk/types/restricted-apis" />
 export * from './sdk';
-export * from './sdk/runtime';
-export * from './sdk/utils';
-// Export HTTP response helpers
-export * from './sdk/utils/capabilities/http/http-helpers';
-export * from './sdk/wasm';

package/dist/pb.d.ts

@@ -0,0 +1,6 @@
+export * as EVM_PB from './generated/capabilities/blockchain/evm/v1alpha/client_pb';
+export * as HTTP_CLIENT_PB from './generated/capabilities/networking/http/v1alpha/client_pb';
+export * as HTTP_TRIGGER_PB from './generated/capabilities/networking/http/v1alpha/trigger_pb';
+export * as CRON_TRIGGER_PB from './generated/capabilities/scheduler/cron/v1/trigger_pb';
+export * as SDK_PB from './generated/sdk/v1alpha/sdk_pb';
+export * as VALUES_PB from './generated/values/v1/values_pb';

package/dist/pb.js

@@ -0,0 +1,6 @@
+export * as EVM_PB from './generated/capabilities/blockchain/evm/v1alpha/client_pb';
+export * as HTTP_CLIENT_PB from './generated/capabilities/networking/http/v1alpha/client_pb';
+export * as HTTP_TRIGGER_PB from './generated/capabilities/networking/http/v1alpha/trigger_pb';
+export * as CRON_TRIGGER_PB from './generated/capabilities/scheduler/cron/v1/trigger_pb';
+export * as SDK_PB from './generated/sdk/v1alpha/sdk_pb';
+export * as VALUES_PB from './generated/values/v1/values_pb';

package/dist/sdk/cre/index.d.ts

@@ -2,14 +2,21 @@
  * Public API for the CRE SDK.
  */
 import { ClientCapability as EVMClient } from '../../generated-sdk/capabilities/blockchain/evm/v1alpha/client_sdk_gen';
-import { ClientCapability as HTTPClient, type SendRequester as HTTPSendRequester } from '../../generated-sdk/capabilities/networking/http/v1alpha/client_sdk_gen';
+import { ClientCapability as HTTPClient } from '../../generated-sdk/capabilities/networking/http/v1alpha/client_sdk_gen';
 import { HTTPCapability } from '../../generated-sdk/capabilities/networking/http/v1alpha/http_sdk_gen';
 import { CronCapability } from '../../generated-sdk/capabilities/scheduler/cron/v1/cron_sdk_gen';
+/**
+ * Public exports for the CRE SDK.
+ */
 export { type Log as EVMLog, TxStatus, } from '../../generated/capabilities/blockchain/evm/v1alpha/client_pb';
 export type { Payload as HTTPPayload } from '../../generated/capabilities/networking/http/v1alpha/trigger_pb';
 export type { Payload as CronPayload } from '../../generated/capabilities/scheduler/cron/v1/trigger_pb';
+export { ClientCapability as EVMClient } from '../../generated-sdk/capabilities/blockchain/evm/v1alpha/client_sdk_gen';
+export { ClientCapability as HTTPClient, type SendRequester as HTTPSendRequester, } from '../../generated-sdk/capabilities/networking/http/v1alpha/client_sdk_gen';
+export { HTTPCapability } from '../../generated-sdk/capabilities/networking/http/v1alpha/http_sdk_gen';
+export { CronCapability } from '../../generated-sdk/capabilities/scheduler/cron/v1/cron_sdk_gen';
 export type { NodeRuntime, Runtime } from '../runtime';
-export type { HTTPSendRequester };
+export { handler } from '../workflow';
 export declare const cre: {
     capabilities: {
         CronCapability: typeof CronCapability;

package/dist/sdk/cre/index.js

@@ -2,12 +2,23 @@
  * Public API for the CRE SDK.
  */
 import { ClientCapability as EVMClient } from '../../generated-sdk/capabilities/blockchain/evm/v1alpha/client_sdk_gen';
-import { ClientCapability as HTTPClient, } from '../../generated-sdk/capabilities/networking/http/v1alpha/client_sdk_gen';
+import { ClientCapability as HTTPClient } from '../../generated-sdk/capabilities/networking/http/v1alpha/client_sdk_gen';
 import { HTTPCapability } from '../../generated-sdk/capabilities/networking/http/v1alpha/http_sdk_gen';
 import { CronCapability } from '../../generated-sdk/capabilities/scheduler/cron/v1/cron_sdk_gen';
 import { prepareRuntime } from '../utils/prepare-runtime';
 import { handler } from '../workflow';
+/**
+ * Public exports for the CRE SDK.
+ */
 export { TxStatus, } from '../../generated/capabilities/blockchain/evm/v1alpha/client_pb';
+// EVM Capability
+export { ClientCapability as EVMClient } from '../../generated-sdk/capabilities/blockchain/evm/v1alpha/client_sdk_gen';
+// HTTP Capability
+export { ClientCapability as HTTPClient, } from '../../generated-sdk/capabilities/networking/http/v1alpha/client_sdk_gen';
+export { HTTPCapability } from '../../generated-sdk/capabilities/networking/http/v1alpha/http_sdk_gen';
+// CRON Capability
+export { CronCapability } from '../../generated-sdk/capabilities/scheduler/cron/v1/cron_sdk_gen';
+export { handler } from '../workflow';
 prepareRuntime();
 export const cre = {
     capabilities: {

package/dist/sdk/index.d.ts

@@ -2,4 +2,7 @@ export * from './cre';
 export * from './report';
 export type * from './runtime';
 export * from './runtime';
+export * from './utils';
+export * from './utils/capabilities/http/http-helpers';
+export * from './wasm';
 export * from './workflow';

package/dist/sdk/index.js

@@ -1,4 +1,8 @@
 export * from './cre';
 export * from './report';
 export * from './runtime';
+export * from './utils';
+// Export HTTP response helpers
+export * from './utils/capabilities/http/http-helpers';
+export * from './wasm';
 export * from './workflow';

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

@@ -0,0 +1,83 @@
+// 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
+ */
+declare global {
+	/**
+	 * Initiates an asynchronous capability call
+	 * @param request - protobuf request as bytes
+	 * @returns Callback ID for the async operation
+	 */
+	function callCapability(request: Uint8Array): number
+
+	/**
+	 * Awaits completion of async capability calls
+	 * @param awaitRequest - protobuf await request as bytes
+	 * @param maxResponseLen - Maximum response size in bytes
+	 * @returns response as bytes
+	 */
+	function awaitCapabilities(awaitRequest: Uint8Array, maxResponseLen: number): Uint8Array
+
+	/**
+	 * Gets secrets asynchronously
+	 * @param request - protobuf secret request as bytes
+	 * @param maxResponseLen - Maximum response size in bytes
+	 * @returns Callback ID for the async operation
+	 */
+	function getSecrets(request: Uint8Array, maxResponseLen: number): number
+
+	/**
+	 * Awaits completion of async secret requests
+	 * @param awaitRequest - protobuf await secret request as bytes
+	 * @param maxResponseLen - Maximum response size in bytes
+	 * @returns response as bytes
+	 */
+	function awaitSecrets(awaitRequest: Uint8Array, maxResponseLen: number): Uint8Array
+
+	/**
+	 * Logs a message to the host runtime
+	 * @param message - The message to log
+	 */
+	function log(message: string): void
+
+	/**
+	 * Sends a response back to the host
+	 * @param response - bytes response
+	 * @returns Status code (0 for success)
+	 */
+	function sendResponse(response: Uint8Array): number
+
+	/**
+	 * Switches execution mode between NODE and DON
+	 * @param mode - The mode to switch to (0 = UNSPECIFIED, 1 = DON, 2 = NODE)
+	 */
+	function switchModes(mode: 0 | 1 | 2): void
+
+	/**
+	 * Indicates this is a V2 SDK workflow
+	 */
+	function versionV2(): void
+
+	/**
+	 * Gets a random seed from the host
+	 * @param mode - 1 for non-deterministic, 2 for deterministic
+	 * @returns Random seed value
+	 */
+	function randomSeed(mode: 1 | 2): number
+
+	/**
+	 * Gets WASI command line arguments
+	 * @returns Serialized arguments
+	 */
+	function getWasiArgs(): string
+
+	/**
+	 * Gets the current time from the host runtime
+	 * @returns Unix timestamp in milliseconds
+	 */
+	function now(): number
+}
+
+export {}

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

@@ -0,0 +1,27 @@
+declare global {
+	/** @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/capabilities/http/http-helpers.d.ts

@@ -1,4 +1,7 @@
-import type { Response } from '../../../../generated/capabilities/networking/http/v1alpha/client_pb';
+import type { Request, RequestJson, Response } from '../../../../generated/capabilities/networking/http/v1alpha/client_pb';
+import type { ReportResponse } from '../../../../generated/sdk/v1alpha/sdk_pb';
+import type { NodeRuntime } from '../../..';
+import type { Report } from '../../../report';
 /**
  * HTTP Response Helper Functions
  *
@@ -110,3 +113,36 @@ export declare function ok(responseFn: () => {
 }): {
     result: () => boolean;
 };
+declare module '../../../../generated-sdk/capabilities/networking/http/v1alpha/client_sdk_gen' {
+    interface ClientCapability {
+        /**
+         * SendReport functions the same as SendRequest, but takes a Report and a function
+         * to convert the inner ReportResponse to a Request.
+         * Note that caching is limited as reports may contain different sets of signatures
+         * on different nodes, leading to a cache miss.
+         *
+         * @param runtime - The runtime instance
+         * @param report - The Report to process
+         * @param fn - Function to convert ReportResponse to Request
+         * @returns Response result function
+         */
+        sendReport(runtime: NodeRuntime<unknown>, report: Report, fn: (reportResponse: ReportResponse) => Request | RequestJson): {
+            result: () => Response;
+        };
+    }
+    interface SendRequester {
+        /**
+         * SendReport functions the same as SendRequest, but takes a Report and a function
+         * to convert the inner ReportResponse to a Request.
+         * Note that caching is limited as reports may contain different sets of signatures
+         * on different nodes, leading to a cache miss.
+         *
+         * @param report - The Report to process
+         * @param fn - Function to convert ReportResponse to Request
+         * @returns Response result function
+         */
+        sendReport(report: Report, fn: (reportResponse: ReportResponse) => Request | RequestJson): {
+            result: () => Response;
+        };
+    }
+}

package/dist/sdk/utils/capabilities/http/http-helpers.js

@@ -1,3 +1,4 @@
+import { decodeJson } from '../../decode-json';
 export function text(responseOrFn) {
     if (typeof responseOrFn === 'function') {
         return {
@@ -15,11 +16,7 @@ export function json(responseOrFn) {
             result: () => json(responseOrFn().result),
         };
     }
-    else {
-        const decoder = new TextDecoder('utf-8');
-        const textBody = decoder.decode(responseOrFn.body);
-        return JSON.parse(textBody);
-    }
+    return decodeJson(responseOrFn.body);
 }
 export function getHeader(responseOrFn, name) {
     if (typeof responseOrFn === 'function') {
@@ -42,3 +39,46 @@ export function ok(responseOrFn) {
         return responseOrFn.statusCode >= 200 && responseOrFn.statusCode < 300;
     }
 }
+// ============================================================================
+// SendReport Helper Methods for ClientCapability and SendRequester
+// ============================================================================
+/**
+ * SendReport functions the same as SendRequest, but takes a Report and a function
+ * to convert the inner ReportResponse to a Request.
+ * Note that caching is limited as reports may contain different sets of signatures
+ * on different nodes, leading to a cache miss.
+ *
+ * @param runtime - The runtime instance
+ * @param report - The Report to process
+ * @param fn - Function to convert ReportResponse to Request
+ * @returns Response result function
+ */
+function sendReport(runtime, report, fn) {
+    const rawReport = report.x_generatedCodeOnly_unwrap();
+    const request = fn(rawReport);
+    return this.sendRequest(runtime, request);
+}
+/**
+ * SendReport functions the same as SendRequest, but takes a Report and a function
+ * to convert the inner ReportResponse to a Request.
+ * Note that caching is limited as reports may contain different sets of signatures
+ * on different nodes, leading to a cache miss.
+ *
+ * @param report - The Report to process
+ * @param fn - Function to convert ReportResponse to Request
+ * @returns Response result function
+ */
+function sendRequesterSendReport(report, fn) {
+    const rawReport = report.x_generatedCodeOnly_unwrap();
+    const request = fn(rawReport);
+    return this.sendRequest(request);
+}
+// ============================================================================
+// Prototype Extensions
+// ============================================================================
+// Import the actual classes for prototype extension
+import { ClientCapability as ClientCapabilityClass, SendRequester as SendRequesterClass, } from '../../../../generated-sdk/capabilities/networking/http/v1alpha/client_sdk_gen';
+// Extend ClientCapability prototype
+ClientCapabilityClass.prototype.sendReport = sendReport;
+// Extend SendRequester prototype
+SendRequesterClass.prototype.sendReport = sendRequesterSendReport;

package/dist/sdk/utils/decode-json.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Decodes a Uint8Array into a JSON object.
+ * Function would throw if the input is not a valid JSON string encoded as bytes.
+ *
+ * @param input - The Uint8Array to decode.
+ * @returns The decoded JSON object.
+ */
+export declare const decodeJson: (input: Uint8Array) => any;

package/dist/sdk/utils/decode-json.js

@@ -0,0 +1,12 @@
+/**
+ * Decodes a Uint8Array into a JSON object.
+ * Function would throw if the input is not a valid JSON string encoded as bytes.
+ *
+ * @param input - The Uint8Array to decode.
+ * @returns The decoded JSON object.
+ */
+export const decodeJson = (input) => {
+    const decoder = new TextDecoder('utf-8');
+    const textBody = decoder.decode(input);
+    return JSON.parse(textBody);
+};

package/dist/sdk/utils/index.d.ts

@@ -1,6 +1,7 @@
 export * from './capabilities/blockchain/blockchain-helpers';
 export * from './capabilities/http/http-helpers';
 export * from './chain-selectors';
+export * from './decode-json';
 export * from './hex-utils';
 export * from './values/consensus_aggregators';
 export * from './values/serializer_types';

package/dist/sdk/utils/index.js

@@ -1,6 +1,7 @@
 export * from './capabilities/blockchain/blockchain-helpers';
 export * from './capabilities/http/http-helpers';
 export * from './chain-selectors';
+export * from './decode-json';
 export * from './hex-utils';
 export * from './values/consensus_aggregators';
 export * from './values/serializer_types';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@chainlink/cre-sdk",
-	"version": "0.0.5-alpha",
+	"version": "0.0.7-alpha",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -8,6 +8,13 @@
 		".": {
 			"types": "./dist/index.d.ts",
 			"import": "./dist/index.js"
+		},
+		"./restricted-apis": {
+			"types": "./dist/sdk/types/restricted-apis.d.ts"
+		},
+		"./pb": {
+			"types": "./dist/pb.d.ts",
+			"import": "./dist/pb.js"
 		}
 	},
 	"bin": {
@@ -22,7 +29,8 @@
 		"LICENSE.md"
 	],
 	"scripts": {
-		"build": "bun run clean && bun run compile:build && bun run fix-imports",
+		"build": "bun run clean && bun run compile:build && bun run build:types && bun run fix-imports",
+		"build:types": "bun run scripts/run.ts build-types",
 		"check": "biome check --write ${BIOME_PATHS:-.}",
 		"clean": "rm -rf dist",
 		"compile:all-standard-tests": "bun scripts/run.ts compile-all-standard-tests",
@@ -33,12 +41,12 @@
 		"compile:workflow": "bun scripts/run.ts compile-workflow",
 		"fix-imports": "bun scripts/run.ts fix-imports",
 		"format": "biome format --write ${BIOME_PATHS:-.}",
-		"full-checks": "bun generate:sdk && bun build && bun typecheck && bun lint && bun test && bun test:standard",
+		"full-checks": "bun generate:sdk && bun build && bun typecheck && bun check && bun test && bun test:standard",
 		"generate:chain-selectors": "bun scripts/run.ts generate-chain-selectors && BIOME_PATHS=\"src/generated\" bun check",
 		"generate:proto": "bunx @bufbuild/buf generate && BIOME_PATHS=\"src/generated\" bun check",
 		"generate:sdk": "bun generate:proto && bun generate:chain-selectors && bun scripts/run generate-sdks && BIOME_PATHS=\"src/generated src/generated-sdk\" bun check",
 		"lint": "biome lint --write",
-		"prepublishOnly": "bun typecheck && bun lint && bun test && bun test:standard",
+		"prepublishOnly": "bun typecheck && bun check && bun test && bun test:standard",
 		"test": "bun test",
 		"test:standard": "./scripts/run-standard-tests.sh",
 		"typecheck": "tsc"
@@ -46,7 +54,7 @@
 	"dependencies": {
 		"@bufbuild/protobuf": "2.6.3",
 		"@bufbuild/protoc-gen-es": "2.6.3",
-		"@chainlink/cre-sdk-javy-plugin": "0.0.4-alpha",
+		"@chainlink/cre-sdk-javy-plugin": "0.0.5-alpha",
 		"@standard-schema/spec": "1.0.0",
 		"viem": "2.34.0",
 		"zod": "3.25.76"

package/scripts/run.ts

@@ -1,14 +1,14 @@
 #!/usr/bin/env bun
 
 const availableScripts = [
+	'build-types',
 	'compile-to-js',
 	'compile-to-wasm',
 	'compile-workflow', // TS -> JS -> WASM compilation in single script
 	'compile-all-standard-tests', // Do the above but for all standard tests
-
+	'fix-imports', // Fix @cre/* imports to relative paths
 	'generate-chain-selectors',
 	'generate-sdks',
-	'fix-imports', // Fix @cre/* imports to relative paths
 ]
 
 /**

package/scripts/src/build-types.ts

@@ -0,0 +1,33 @@
+import { glob } from 'fast-glob'
+import { copyFile, mkdir } from 'fs/promises'
+import { join } from 'path'
+
+const buildTypes = async () => {
+	console.log('🔧 Copying type definition files to dist...')
+
+	// Define paths relative to the scripts directory
+	const packageRoot = join(import.meta.dir, '../..')
+	const sourceDir = join(packageRoot, 'src/sdk/types')
+	const destDir = join(packageRoot, 'dist/sdk/types')
+
+	// Ensure the destination directory exists
+	await mkdir(destDir, { recursive: true })
+
+	// Find all .d.ts files in the source directory
+	const typeFiles = await glob('*.d.ts', {
+		cwd: sourceDir,
+		absolute: false,
+	})
+
+	// Copy each file
+	for (const file of typeFiles) {
+		const sourceFile = join(sourceDir, file)
+		const destFile = join(destDir, file)
+		await copyFile(sourceFile, destFile)
+		console.log(`  ✓ Copied ${file}`)
+	}
+
+	console.log(`✅ Copied ${typeFiles.length} type definition file(s) to dist/sdk/types`)
+}
+
+export const main = buildTypes