@chainlink/cre-sdk 1.6.0-alpha.3 → 1.6.0-alpha.5

package/README.md

@@ -516,6 +516,15 @@ This SDK uses [@bufbuild/protobuf](https://www.npmjs.com/package/@bufbuild/proto
 - `buf.gen.yaml` - Code generation configuration using ts-proto
 - Generated files are placed in `src/generated/`
 
+**Opt-in proto allowlist:**
+
+[`buf.gen.yaml`](./buf.gen.yaml) uses an explicit `paths:` allowlist under its `inputs`. Protos added to the `chainlink-protos` submodule are **not** picked up automatically — a new capability must be added to both:
+
+1. [`packages/cre-sdk/buf.gen.yaml`](./buf.gen.yaml) — to generate the raw `*_pb.ts` types.
+2. [`packages/cre-sdk/scripts/src/generate-sdks.ts`](./scripts/src/generate-sdks.ts) — to generate the SDK wrapper classes and mocks.
+
+This prevents leaking in-progress or internal capabilities into the public SDK surface before they are ready.
+
 ### Chain Selectors Generation
 
 Auto-generated TypeScript files for 200+ blockchain networks from the official [Chainlink chain-selectors repository](https://github.com/smartcontractkit/chain-selectors).

package/bin/cre-compile.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env bun
 
 import { main as compileWorkflow } from "../scripts/src/compile-workflow";
+import { parseCompileFlags } from "@chainlink/cre-sdk-javy-plugin/scripts/parse-compile-flags";
 import {
   parseCompileCliArgs,
   skipTypeChecksFlag,
@@ -9,26 +10,34 @@ import { WorkflowTypecheckError } from "../scripts/src/typecheck-workflow";
 import { WorkflowRuntimeCompatibilityError } from "../scripts/src/validate-workflow-runtime-compat";
 
 const main = async () => {
+  const cliArgs = process.argv.slice(2);
+  const { creExports, plugin, rest } = parseCompileFlags(cliArgs);
+
   let inputPath: string | undefined;
   let outputPathArg: string | undefined;
   let skipTypeChecks = false;
 
   try {
-    const parsed = parseCompileCliArgs(process.argv.slice(2));
+    const parsed = parseCompileCliArgs(rest);
     inputPath = parsed.inputPath;
     outputPathArg = parsed.outputPath;
     skipTypeChecks = parsed.skipTypeChecks;
   } catch (error) {
     console.error(error instanceof Error ? error.message : error);
     console.error(
-      `Usage: cre-compile <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`,
+      `Usage: cre-compile [--plugin <path>] [--cre-exports <crate-dir>]... <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`,
     );
     process.exit(1);
   }
 
+  if (plugin !== null && creExports.length > 0) {
+    console.error("❌ Error: --plugin and --cre-exports are mutually exclusive.");
+    process.exit(1);
+  }
+
   if (!inputPath) {
     console.error(
-      `Usage: cre-compile <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`,
+      `Usage: cre-compile [--plugin <path>] [--cre-exports <crate-dir>]... <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`,
     );
     console.error("Examples:");
     console.error("  cre-compile src/standard_tests/secrets/test.ts");
@@ -41,10 +50,13 @@ const main = async () => {
     process.exit(1);
   }
 
-  await compileWorkflow(inputPath, outputPathArg, { skipTypeChecks });
+  await compileWorkflow(inputPath, outputPathArg, {
+    skipTypeChecks,
+    creExports: creExports.length > 0 ? creExports : undefined,
+    plugin,
+  });
 };
 
-// CLI entry point
 main().catch((e) => {
   if (
     e instanceof WorkflowRuntimeCompatibilityError ||

package/dist/generated/workflows/v2/cre_info_pb.d.ts

@@ -0,0 +1,123 @@
+import type { Message } from '@bufbuild/protobuf';
+import type { GenFile, GenMessage } from '@bufbuild/protobuf/codegenv2';
+/**
+ * Describes the file workflows/v2/cre_info.proto.
+ */
+export declare const file_workflows_v2_cre_info: GenFile;
+/**
+ * @generated from message workflows.v2.CreInfo
+ */
+export type CreInfo = Message<'workflows.v2.CreInfo'> & {
+    /**
+     * @generated from field: int32 donID = 1;
+     */
+    donID: number;
+    /**
+     * @generated from field: int32 donF = 2;
+     */
+    donF: number;
+    /**
+     * @generated from field: int32 donN = 3;
+     */
+    donN: number;
+    /**
+     * @generated from field: string p2pID = 4;
+     */
+    p2pID: string;
+    /**
+     * @generated from field: string workflowRegistryAddress = 5;
+     */
+    workflowRegistryAddress: string;
+    /**
+     * @generated from field: string workflowRegistryVersion = 6;
+     */
+    workflowRegistryVersion: string;
+    /**
+     * @generated from field: string workflowRegistryChain = 7;
+     */
+    workflowRegistryChain: string;
+    /**
+     * @generated from field: string engineVersion = 8;
+     */
+    engineVersion: string;
+    /**
+     * @generated from field: string capabilitiesRegistryVersion = 9;
+     */
+    capabilitiesRegistryVersion: string;
+    /**
+     * @generated from field: string donVersion = 10;
+     */
+    donVersion: string;
+    /**
+     * workflowSource identifies where the workflow was deployed from.
+     * Format varies by source type:
+     *   - Onchain contract: "contract:{chain_selector}:{contract_address}"
+     *   - GRPC source:      "grpc:{source_name}:v1"
+     *   - File source:      "file:{source_name}:v1"
+     *
+     * @generated from field: string workflowSource = 11;
+     */
+    workflowSource: string;
+};
+/**
+ * @generated from message workflows.v2.CreInfo
+ */
+export type CreInfoJson = {
+    /**
+     * @generated from field: int32 donID = 1;
+     */
+    donID?: number;
+    /**
+     * @generated from field: int32 donF = 2;
+     */
+    donF?: number;
+    /**
+     * @generated from field: int32 donN = 3;
+     */
+    donN?: number;
+    /**
+     * @generated from field: string p2pID = 4;
+     */
+    p2pID?: string;
+    /**
+     * @generated from field: string workflowRegistryAddress = 5;
+     */
+    workflowRegistryAddress?: string;
+    /**
+     * @generated from field: string workflowRegistryVersion = 6;
+     */
+    workflowRegistryVersion?: string;
+    /**
+     * @generated from field: string workflowRegistryChain = 7;
+     */
+    workflowRegistryChain?: string;
+    /**
+     * @generated from field: string engineVersion = 8;
+     */
+    engineVersion?: string;
+    /**
+     * @generated from field: string capabilitiesRegistryVersion = 9;
+     */
+    capabilitiesRegistryVersion?: string;
+    /**
+     * @generated from field: string donVersion = 10;
+     */
+    donVersion?: string;
+    /**
+     * workflowSource identifies where the workflow was deployed from.
+     * Format varies by source type:
+     *   - Onchain contract: "contract:{chain_selector}:{contract_address}"
+     *   - GRPC source:      "grpc:{source_name}:v1"
+     *   - File source:      "file:{source_name}:v1"
+     *
+     * @generated from field: string workflowSource = 11;
+     */
+    workflowSource?: string;
+};
+/**
+ * Describes the message workflows.v2.CreInfo.
+ * Use `create(CreInfoSchema)` to create a new message.
+ */
+export declare const CreInfoSchema: GenMessage<CreInfo, {
+    jsonType: CreInfoJson;
+}>;

package/dist/generated/workflows/v2/cre_info_pb.js

@@ -0,0 +1,17 @@
+// @generated by protoc-gen-es v2.6.3 with parameter "target=ts,import_extension=none,json_types=true,keep_empty_files=false"
+// @generated from file workflows/v2/cre_info.proto (package workflows.v2, syntax proto3)
+/* eslint-disable */
+import { fileDesc, messageDesc } from '@bufbuild/protobuf/codegenv2';
+/**
+ * Describes the file workflows/v2/cre_info.proto.
+ */
+export const file_workflows_v2_cre_info = 
+/*@__PURE__*/
+fileDesc('Cht3b3JrZmxvd3MvdjIvY3JlX2luZm8ucHJvdG8SDHdvcmtmbG93cy52MiKMAgoHQ3JlSW5mbxINCgVkb25JRBgBIAEoBRIMCgRkb25GGAIgASgFEgwKBGRvbk4YAyABKAUSDQoFcDJwSUQYBCABKAkSHwoXd29ya2Zsb3dSZWdpc3RyeUFkZHJlc3MYBSABKAkSHwoXd29ya2Zsb3dSZWdpc3RyeVZlcnNpb24YBiABKAkSHQoVd29ya2Zsb3dSZWdpc3RyeUNoYWluGAcgASgJEhUKDWVuZ2luZVZlcnNpb24YCCABKAkSIwobY2FwYWJpbGl0aWVzUmVnaXN0cnlWZXJzaW9uGAkgASgJEhIKCmRvblZlcnNpb24YCiABKAkSFgoOd29ya2Zsb3dTb3VyY2UYCyABKAlCrwEKEGNvbS53b3JrZmxvd3MudjJCDENyZUluZm9Qcm90b1ABWjxnaXRodWIuY29tL3NtYXJ0Y29udHJhY3RraXQvY2hhaW5saW5rLXByb3Rvcy93b3JrZmxvd3MvZ28vdjKiAgNXWFiqAgxXb3JrZmxvd3MuVjLKAgxXb3JrZmxvd3NcVjLiAhhXb3JrZmxvd3NcVjJcR1BCTWV0YWRhdGHqAg1Xb3JrZmxvd3M6OlYyYgZwcm90bzM');
+/**
+ * Describes the message workflows.v2.CreInfo.
+ * Use `create(CreInfoSchema)` to create a new message.
+ */
+export const CreInfoSchema = 
+/*@__PURE__*/
+messageDesc(file_workflows_v2_cre_info, 0);

package/dist/generated/workflows/v2/workflow_key_pb.d.ts

@@ -0,0 +1,55 @@
+import type { Message } from '@bufbuild/protobuf';
+import type { GenFile, GenMessage } from '@bufbuild/protobuf/codegenv2';
+/**
+ * Describes the file workflows/v2/workflow_key.proto.
+ */
+export declare const file_workflows_v2_workflow_key: GenFile;
+/**
+ * @generated from message workflows.v2.WorkflowKey
+ */
+export type WorkflowKey = Message<'workflows.v2.WorkflowKey'> & {
+    /**
+     * @generated from field: string workflowOwner = 1;
+     */
+    workflowOwner: string;
+    /**
+     * @generated from field: string workflowName = 2;
+     */
+    workflowName: string;
+    /**
+     * @generated from field: string workflowID = 3;
+     */
+    workflowID: string;
+    /**
+     * @generated from field: string organizationID = 4;
+     */
+    organizationID: string;
+};
+/**
+ * @generated from message workflows.v2.WorkflowKey
+ */
+export type WorkflowKeyJson = {
+    /**
+     * @generated from field: string workflowOwner = 1;
+     */
+    workflowOwner?: string;
+    /**
+     * @generated from field: string workflowName = 2;
+     */
+    workflowName?: string;
+    /**
+     * @generated from field: string workflowID = 3;
+     */
+    workflowID?: string;
+    /**
+     * @generated from field: string organizationID = 4;
+     */
+    organizationID?: string;
+};
+/**
+ * Describes the message workflows.v2.WorkflowKey.
+ * Use `create(WorkflowKeySchema)` to create a new message.
+ */
+export declare const WorkflowKeySchema: GenMessage<WorkflowKey, {
+    jsonType: WorkflowKeyJson;
+}>;

package/dist/generated/workflows/v2/workflow_key_pb.js

@@ -0,0 +1,17 @@
+// @generated by protoc-gen-es v2.6.3 with parameter "target=ts,import_extension=none,json_types=true,keep_empty_files=false"
+// @generated from file workflows/v2/workflow_key.proto (package workflows.v2, syntax proto3)
+/* eslint-disable */
+import { fileDesc, messageDesc } from '@bufbuild/protobuf/codegenv2';
+/**
+ * Describes the file workflows/v2/workflow_key.proto.
+ */
+export const file_workflows_v2_workflow_key = 
+/*@__PURE__*/
+fileDesc('Ch93b3JrZmxvd3MvdjIvd29ya2Zsb3dfa2V5LnByb3RvEgx3b3JrZmxvd3MudjIiZgoLV29ya2Zsb3dLZXkSFQoNd29ya2Zsb3dPd25lchgBIAEoCRIUCgx3b3JrZmxvd05hbWUYAiABKAkSEgoKd29ya2Zsb3dJRBgDIAEoCRIWCg5vcmdhbml6YXRpb25JRBgEIAEoCUKzAQoQY29tLndvcmtmbG93cy52MkIQV29ya2Zsb3dLZXlQcm90b1ABWjxnaXRodWIuY29tL3NtYXJ0Y29udHJhY3RraXQvY2hhaW5saW5rLXByb3Rvcy93b3JrZmxvd3MvZ28vdjKiAgNXWFiqAgxXb3JrZmxvd3MuVjLKAgxXb3JrZmxvd3NcVjLiAhhXb3JrZmxvd3NcVjJcR1BCTWV0YWRhdGHqAg1Xb3JrZmxvd3M6OlYyYgZwcm90bzM');
+/**
+ * Describes the message workflows.v2.WorkflowKey.
+ * Use `create(WorkflowKeySchema)` to create a new message.
+ */
+export const WorkflowKeySchema = 
+/*@__PURE__*/
+messageDesc(file_workflows_v2_workflow_key, 0);

package/dist/generated/workflows/v2/workflow_user_metric_pb.d.ts

@@ -0,0 +1,118 @@
+import type { Message } from '@bufbuild/protobuf';
+import type { GenEnum, GenFile, GenMessage } from '@bufbuild/protobuf/codegenv2';
+import type { CreInfo, CreInfoJson } from './cre_info_pb';
+import type { WorkflowKey, WorkflowKeyJson } from './workflow_key_pb';
+/**
+ * Describes the file workflows/v2/workflow_user_metric.proto.
+ */
+export declare const file_workflows_v2_workflow_user_metric: GenFile;
+/**
+ * @generated from message workflows.v2.WorkflowUserMetric
+ */
+export type WorkflowUserMetric = Message<'workflows.v2.WorkflowUserMetric'> & {
+    /**
+     * @generated from field: workflows.v2.CreInfo creInfo = 1;
+     */
+    creInfo?: CreInfo;
+    /**
+     * @generated from field: workflows.v2.WorkflowKey workflow = 2;
+     */
+    workflow?: WorkflowKey;
+    /**
+     * @generated from field: string workflowExecutionID = 3;
+     */
+    workflowExecutionID: string;
+    /**
+     * @generated from field: string timestamp = 4;
+     */
+    timestamp: string;
+    /**
+     * @generated from field: string name = 5;
+     */
+    name: string;
+    /**
+     * @generated from field: double value = 6;
+     */
+    value: number;
+    /**
+     * @generated from field: workflows.v2.UserMetricType type = 7;
+     */
+    type: UserMetricType;
+    /**
+     * @generated from field: map<string, string> labels = 8;
+     */
+    labels: {
+        [key: string]: string;
+    };
+};
+/**
+ * @generated from message workflows.v2.WorkflowUserMetric
+ */
+export type WorkflowUserMetricJson = {
+    /**
+     * @generated from field: workflows.v2.CreInfo creInfo = 1;
+     */
+    creInfo?: CreInfoJson;
+    /**
+     * @generated from field: workflows.v2.WorkflowKey workflow = 2;
+     */
+    workflow?: WorkflowKeyJson;
+    /**
+     * @generated from field: string workflowExecutionID = 3;
+     */
+    workflowExecutionID?: string;
+    /**
+     * @generated from field: string timestamp = 4;
+     */
+    timestamp?: string;
+    /**
+     * @generated from field: string name = 5;
+     */
+    name?: string;
+    /**
+     * @generated from field: double value = 6;
+     */
+    value?: number | 'NaN' | 'Infinity' | '-Infinity';
+    /**
+     * @generated from field: workflows.v2.UserMetricType type = 7;
+     */
+    type?: UserMetricTypeJson;
+    /**
+     * @generated from field: map<string, string> labels = 8;
+     */
+    labels?: {
+        [key: string]: string;
+    };
+};
+/**
+ * Describes the message workflows.v2.WorkflowUserMetric.
+ * Use `create(WorkflowUserMetricSchema)` to create a new message.
+ */
+export declare const WorkflowUserMetricSchema: GenMessage<WorkflowUserMetric, {
+    jsonType: WorkflowUserMetricJson;
+}>;
+/**
+ * @generated from enum workflows.v2.UserMetricType
+ */
+export declare enum UserMetricType {
+    /**
+     * @generated from enum value: USER_METRIC_TYPE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: USER_METRIC_TYPE_COUNTER = 1;
+     */
+    COUNTER = 1,
+    /**
+     * @generated from enum value: USER_METRIC_TYPE_GAUGE = 2;
+     */
+    GAUGE = 2
+}
+/**
+ * @generated from enum workflows.v2.UserMetricType
+ */
+export type UserMetricTypeJson = 'USER_METRIC_TYPE_UNSPECIFIED' | 'USER_METRIC_TYPE_COUNTER' | 'USER_METRIC_TYPE_GAUGE';
+/**
+ * Describes the enum workflows.v2.UserMetricType.
+ */
+export declare const UserMetricTypeSchema: GenEnum<UserMetricType, UserMetricTypeJson>;

package/dist/generated/workflows/v2/workflow_user_metric_pb.js

@@ -0,0 +1,41 @@
+// @generated by protoc-gen-es v2.6.3 with parameter "target=ts,import_extension=none,json_types=true,keep_empty_files=false"
+// @generated from file workflows/v2/workflow_user_metric.proto (package workflows.v2, syntax proto3)
+/* eslint-disable */
+import { enumDesc, fileDesc, messageDesc } from '@bufbuild/protobuf/codegenv2';
+import { file_workflows_v2_cre_info } from './cre_info_pb';
+import { file_workflows_v2_workflow_key } from './workflow_key_pb';
+/**
+ * Describes the file workflows/v2/workflow_user_metric.proto.
+ */
+export const file_workflows_v2_workflow_user_metric = 
+/*@__PURE__*/
+fileDesc('Cid3b3JrZmxvd3MvdjIvd29ya2Zsb3dfdXNlcl9tZXRyaWMucHJvdG8SDHdvcmtmbG93cy52MiLPAgoSV29ya2Zsb3dVc2VyTWV0cmljEiYKB2NyZUluZm8YASABKAsyFS53b3JrZmxvd3MudjIuQ3JlSW5mbxIrCgh3b3JrZmxvdxgCIAEoCzIZLndvcmtmbG93cy52Mi5Xb3JrZmxvd0tleRIbChN3b3JrZmxvd0V4ZWN1dGlvbklEGAMgASgJEhEKCXRpbWVzdGFtcBgEIAEoCRIMCgRuYW1lGAUgASgJEg0KBXZhbHVlGAYgASgBEioKBHR5cGUYByABKA4yHC53b3JrZmxvd3MudjIuVXNlck1ldHJpY1R5cGUSPAoGbGFiZWxzGAggAygLMiwud29ya2Zsb3dzLnYyLldvcmtmbG93VXNlck1ldHJpYy5MYWJlbHNFbnRyeRotCgtMYWJlbHNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBKmwKDlVzZXJNZXRyaWNUeXBlEiAKHFVTRVJfTUVUUklDX1RZUEVfVU5TUEVDSUZJRUQQABIcChhVU0VSX01FVFJJQ19UWVBFX0NPVU5URVIQARIaChZVU0VSX01FVFJJQ19UWVBFX0dBVUdFEAJCugEKEGNvbS53b3JrZmxvd3MudjJCF1dvcmtmbG93VXNlck1ldHJpY1Byb3RvUAFaPGdpdGh1Yi5jb20vc21hcnRjb250cmFjdGtpdC9jaGFpbmxpbmstcHJvdG9zL3dvcmtmbG93cy9nby92MqICA1dYWKoCDFdvcmtmbG93cy5WMsoCDFdvcmtmbG93c1xWMuICGFdvcmtmbG93c1xWMlxHUEJNZXRhZGF0YeoCDVdvcmtmbG93czo6VjJiBnByb3RvMw', [file_workflows_v2_cre_info, file_workflows_v2_workflow_key]);
+/**
+ * Describes the message workflows.v2.WorkflowUserMetric.
+ * Use `create(WorkflowUserMetricSchema)` to create a new message.
+ */
+export const WorkflowUserMetricSchema = /*@__PURE__*/ messageDesc(file_workflows_v2_workflow_user_metric, 0);
+/**
+ * @generated from enum workflows.v2.UserMetricType
+ */
+export var UserMetricType;
+(function (UserMetricType) {
+    /**
+     * @generated from enum value: USER_METRIC_TYPE_UNSPECIFIED = 0;
+     */
+    UserMetricType[UserMetricType["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+    /**
+     * @generated from enum value: USER_METRIC_TYPE_COUNTER = 1;
+     */
+    UserMetricType[UserMetricType["COUNTER"] = 1] = "COUNTER";
+    /**
+     * @generated from enum value: USER_METRIC_TYPE_GAUGE = 2;
+     */
+    UserMetricType[UserMetricType["GAUGE"] = 2] = "GAUGE";
+})(UserMetricType || (UserMetricType = {}));
+/**
+ * Describes the enum workflows.v2.UserMetricType.
+ */
+export const UserMetricTypeSchema = 
+/*@__PURE__*/
+enumDesc(file_workflows_v2_workflow_user_metric, 0);

package/dist/sdk/impl/runtime-impl.d.ts

@@ -43,7 +43,10 @@ export declare class BaseRuntimeImpl<C> implements BaseRuntime<C> {
     getNextCallId(): number;
     now(): Date;
     log(message: string): void;
+    emitMetric(name: string, value: number, type: MetricType, labels?: Record<string, string>): boolean;
 }
+/** Ergonomic union for {@link BaseRuntimeImpl.emitMetric}. */
+export type MetricType = 'counter' | 'gauge';
 /**
  * It is used when a BFT guarantee cannot be provided automatically (e.g. calling a standard API).
  * You tell each node to perform a task on its own.
@@ -112,4 +115,9 @@ export interface RuntimeHelpers {
     now(): number;
     /** Logs a message to the host environment. */
     log(message: string): void;
+    /**
+     * Emits a user metric to the host. Payload is a protobuf-encoded
+     * `workflows.v2.WorkflowUserMetric`. Returns false if the host rejected it.
+     */
+    emitMetric(payload: Uint8Array): boolean;
 }

package/dist/sdk/impl/runtime-impl.js

@@ -1,6 +1,7 @@
-import { create } from '@bufbuild/protobuf';
+import { create, toBinary } from '@bufbuild/protobuf';
 import { anyPack, anyUnpack } from '@bufbuild/protobuf/wkt';
 import { AwaitCapabilitiesRequestSchema, AwaitSecretsRequestSchema, CapabilityRequestSchema, GetSecretsRequestSchema, Mode, SecretRequestSchema, SimpleConsensusInputsSchema, } from '../../generated/sdk/v1alpha/sdk_pb';
+import { UserMetricType, WorkflowUserMetricSchema, } from '../../generated/workflows/v2/workflow_user_metric_pb';
 import { ConsensusCapability } from '../../generated-sdk/capabilities/internal/consensus/v1alpha/consensus_sdk_gen';
 import { Value, } from '../utils';
 import { CapabilityError } from '../utils/capabilities/capability-error';
@@ -139,7 +140,20 @@ export class BaseRuntimeImpl {
     log(message) {
         this.helpers.log(message);
     }
+    emitMetric(name, value, type, labels) {
+        const metric = create(WorkflowUserMetricSchema, {
+            name,
+            value,
+            type: METRIC_TYPE_TO_PROTO[type],
+            labels: labels ?? {},
+        });
+        return this.helpers.emitMetric(toBinary(WorkflowUserMetricSchema, metric));
+    }
 }
+const METRIC_TYPE_TO_PROTO = {
+    counter: UserMetricType.COUNTER,
+    gauge: UserMetricType.GAUGE,
+};
 /**
  * It is used when a BFT guarantee cannot be provided automatically (e.g. calling a standard API).
  * You tell each node to perform a task on its own.

package/dist/sdk/runtime.d.ts

@@ -1,10 +1,11 @@
 import type { Message } from '@bufbuild/protobuf';
 import type { GenMessage } from '@bufbuild/protobuf/codegenv2';
 import type { ReportRequest, ReportRequestJson } from '../generated/sdk/v1alpha/sdk_pb';
+import type { MetricType } from './impl/runtime-impl';
 import type { Report } from './report';
 import type { ConsensusAggregation, PrimitiveTypes, UnwrapOptions } from './utils';
 import type { SecretsProvider } from '.';
-export type { ReportRequest, ReportRequestJson };
+export type { ReportRequest, ReportRequestJson, MetricType };
 export type CallCapabilityParams<I extends Message, O extends Message> = {
     capabilityId: string;
     method: string;
@@ -23,6 +24,7 @@ export interface BaseRuntime<C> {
     };
     now(): Date;
     log(message: string): void;
+    emitMetric(name: string, value: number, type: MetricType, labels?: Record<string, string>): boolean;
 }
 /**
  * Runtime for Node mode execution.

package/dist/sdk/testutils/test-runtime.d.ts

@@ -3,6 +3,7 @@
  * Registry is scoped per test via AsyncLocalStorage; use testWithRuntime to run tests with a registry.
  */
 import type { Any } from '@bufbuild/protobuf/wkt';
+import type { WorkflowUserMetric } from '../../generated/workflows/v2/workflow_user_metric_pb';
 import type { RuntimeHelpers } from '../impl/runtime-impl';
 import { RuntimeImpl } from '../impl/runtime-impl';
 import { TestWriter } from './test-writer';
@@ -80,5 +81,6 @@ export declare class TestRuntime extends RuntimeImpl<unknown> {
     private readonly state;
     constructor(helpers: RuntimeHelpers, maxResponseSize: bigint, testWriter: TestWriter, state: TestRuntimeState);
     getLogs(): string[];
+    getMetrics(): WorkflowUserMetric[];
     setTimeProvider(timeProvider: () => number): void;
 }

package/dist/sdk/testutils/test-runtime.js

@@ -236,6 +236,10 @@ function createTestRuntimeHelpers(registry, secrets, testWriter, state, _maxResp
         log(message) {
             testWriter.log(message);
         },
+        emitMetric(payload) {
+            testWriter.emitMetric(payload);
+            return true;
+        },
     };
 }
 /**
@@ -307,6 +311,9 @@ export class TestRuntime extends RuntimeImpl {
     getLogs() {
         return this.testWriter.getLogs();
     }
+    getMetrics() {
+        return this.testWriter.getMetrics();
+    }
     setTimeProvider(timeProvider) {
         this.state.timeProvider = timeProvider;
     }

package/dist/sdk/testutils/test-writer.d.ts

@@ -1,13 +1,19 @@
+import { type WorkflowUserMetric } from '../../generated/workflows/v2/workflow_user_metric_pb';
 /**
  * In-memory log sink for tests. Captures messages so tests can assert on log output.
  * Equivalent to Go's cre/testutils/test_writer.go.
  */
 export declare class TestWriter {
     private logs;
+    private metrics;
     /** Appends a message to the captured log buffer. */
     log(message: string): void;
     /** Returns a copy of all captured log messages in order. */
     getLogs(): string[];
-    /** Clears the captured log buffer. */
+    /** Captures a serialized WorkflowUserMetric payload. */
+    emitMetric(payload: Uint8Array): void;
+    /** Returns captured metric payloads decoded as `WorkflowUserMetric` protos. */
+    getMetrics(): WorkflowUserMetric[];
+    /** Clears captured logs and metrics. */
     clear(): void;
 }

package/dist/sdk/testutils/test-writer.js

@@ -1,9 +1,12 @@
+import { fromBinary } from '@bufbuild/protobuf';
+import { WorkflowUserMetricSchema, } from '../../generated/workflows/v2/workflow_user_metric_pb';
 /**
  * In-memory log sink for tests. Captures messages so tests can assert on log output.
  * Equivalent to Go's cre/testutils/test_writer.go.
  */
 export class TestWriter {
     logs = [];
+    metrics = [];
     /** Appends a message to the captured log buffer. */
     log(message) {
         this.logs.push(message);
@@ -12,8 +15,17 @@ export class TestWriter {
     getLogs() {
         return [...this.logs];
     }
-    /** Clears the captured log buffer. */
+    /** Captures a serialized WorkflowUserMetric payload. */
+    emitMetric(payload) {
+        this.metrics.push(payload);
+    }
+    /** Returns captured metric payloads decoded as `WorkflowUserMetric` protos. */
+    getMetrics() {
+        return this.metrics.map((bytes) => fromBinary(WorkflowUserMetricSchema, bytes));
+    }
+    /** Clears captured logs and metrics. */
     clear() {
         this.logs = [];
+        this.metrics = [];
     }
 }

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

@@ -45,6 +45,14 @@ declare global {
 	 */
 	function log(message: string): void
 
+	/**
+	 * Emits a user metric to the host. The payload is a protobuf-encoded
+	 * `workflows.v2.WorkflowUserMetric` message.
+	 * @param payload - protobuf-encoded WorkflowUserMetric bytes
+	 * @returns 0 on success, negative on error (rate-limited, oversized, invalid name, etc.)
+	 */
+	function emitMetric(payload: Uint8Array): number
+
 	/**
 	 * Sends a response back to the host
 	 * @param response - bytes response

package/dist/sdk/wasm/host-bindings.d.ts

@@ -5,6 +5,7 @@ export declare const hostBindings: {
     getSecrets: (args_0: Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBuffer>, args_1: number, ...args: unknown[]) => any;
     awaitSecrets: (args_0: Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBuffer>, args_1: number, ...args: unknown[]) => Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBuffer>;
     log: (args_0: string, ...args: unknown[]) => void;
+    emitMetric: (args_0: Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBuffer>, ...args: unknown[]) => number;
     sendResponse: (args_0: Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBuffer>, ...args: unknown[]) => number;
     switchModes: (args_0: Mode, ...args: unknown[]) => void;
     versionV2: (...args: unknown[]) => void;

package/dist/sdk/wasm/host-bindings.js

@@ -27,6 +27,10 @@ const globalHostBindingsSchema = z.object({
         .returns(z.union([z.instanceof(Uint8Array), z.custom()])),
     getWasiArgs: z.function().args().returns(z.string()),
     now: z.function().args().returns(z.number()),
+    emitMetric: z
+        .function()
+        .args(z.union([z.instanceof(Uint8Array), z.custom()]))
+        .returns(z.number()),
 });
 // Validate global host functions at runtime
 const validateGlobalHostBindings = () => {

package/dist/sdk/wasm/runtime.js

@@ -56,4 +56,7 @@ class WasmRuntimeHelpers {
     log(message) {
         hostBindings.log(message);
     }
+    emitMetric(payload) {
+        return hostBindings.emitMetric(payload) >= 0;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@chainlink/cre-sdk",
-	"version": "1.6.0-alpha.3",
+	"version": "1.6.0-alpha.5",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -60,7 +60,7 @@
 	"dependencies": {
 		"@bufbuild/protobuf": "2.6.3",
 		"@bufbuild/protoc-gen-es": "2.6.3",
-		"@chainlink/cre-sdk-javy-plugin": "1.5.0",
+		"@chainlink/cre-sdk-javy-plugin": "1.6.0-alpha.5",
 		"@standard-schema/spec": "1.0.0",
 		"viem": "2.34.0",
 		"zod": "3.25.76"

package/scripts/run-standard-tests.sh

@@ -8,9 +8,9 @@ set -e
 # Create dist test workflow folder
 mkdir -p ./dist/workflows/standard_tests
 
-# Build javy wasm
-if [ ! -f ../cre-sdk-javy-plugin/dist/javy_chainlink_sdk.wasm ]; then
-    echo "Error: javy_chainlink_sdk.wasm not found"
+# Plugin package must be built (initialized plugin is what we ship).
+if [ ! -f ../cre-sdk-javy-plugin/dist/javy-chainlink-sdk.plugin.wasm ]; then
+    echo "Error: javy-chainlink-sdk.plugin.wasm not found (run cre-sdk-javy-plugin build first)"
     exit 1
 fi
 

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

@@ -2,6 +2,7 @@ import { spawn } from 'node:child_process'
 import { existsSync } from 'node:fs'
 import { mkdir } from 'node:fs/promises'
 import path from 'node:path'
+import { parseCompileFlags } from '@chainlink/cre-sdk-javy-plugin/scripts/parse-compile-flags'
 
 function runBun(args: string[]): Promise<void> {
 	return new Promise((resolve, reject) => {
@@ -19,20 +20,29 @@ function runBun(args: string[]): Promise<void> {
 
 const isJsFile = (p: string) => ['.js', '.mjs', '.cjs'].includes(path.extname(p).toLowerCase())
 
-export const main = async (inputFile?: string, outputFile?: string) => {
+export const main = async (
+	inputFile?: string,
+	outputFile?: string,
+	creExportsPaths?: string[],
+	pluginPath?: string | null,
+) => {
 	const cliArgs = process.argv.slice(3)
+	const { creExports: cliCreExports, plugin: cliPlugin, rest: cliRest } = parseCompileFlags(cliArgs)
 
-	// Resolve input/output from params or CLI
-	const inputPath = inputFile ?? cliArgs[0]
-	const outputPathArg = outputFile ?? cliArgs[1]
+	const inputPath = inputFile ?? cliRest[0]
+	const outputPathArg = outputFile ?? cliRest[1]
+	const creExports = creExportsPaths ?? cliCreExports
+	const plugin = pluginPath !== undefined ? pluginPath : cliPlugin
+
+	if (plugin !== null && plugin !== undefined && creExports.length > 0) {
+		console.error('❌ Error: --plugin and --cre-exports are mutually exclusive.')
+		process.exit(1)
+	}
 
 	if (!inputPath) {
 		console.error(
 			'Usage: bun compile:js-to-wasm <path/to/input.(js|mjs|cjs)> [path/to/output.wasm]',
 		)
-		console.error('Examples:')
-		console.error('  bun compile:js-to-wasm ./build/workflows/test.js')
-		console.error('  bun compile:js-to-wasm ./build/workflows/test.mjs ./artifacts/test.wasm')
 		process.exit(1)
 	}
 
@@ -47,31 +57,41 @@ export const main = async (inputFile?: string, outputFile?: string) => {
 		process.exit(1)
 	}
 
-	// Default output = same dir, same basename, .wasm extension
 	const defaultOut = path.join(
 		path.dirname(resolvedInput),
 		path.basename(resolvedInput).replace(/\.(m|c)?js$/i, '.wasm'),
 	)
 	const resolvedOutput = outputPathArg ? path.resolve(outputPathArg) : defaultOut
 
-	// Ensure output directory exists
 	await mkdir(path.dirname(resolvedOutput), { recursive: true })
 
-	console.info(`🔨 Compiling to WASM`)
+	console.info('🔨 Compiling to WASM')
 	console.info(`📁 Input:  ${resolvedInput}`)
 	console.info(`🎯 Output: ${resolvedOutput}`)
 
-	// Prefer the sibling @chainlink/cre-sdk-javy-plugin install (same as monorepo layout).
-	// Bun's shell `$` template can throw EINVAL on some Linux/arm64 Docker setups; use spawn.
-	const scriptDir = import.meta.dir
-	const compilerPath = path.resolve(
-		scriptDir,
-		'../../../cre-sdk-javy-plugin/bin/compile-workflow.ts',
-	)
+	const compileArgs: string[] = []
+	if (plugin != null && plugin !== '') {
+		compileArgs.push('--plugin', path.resolve(plugin))
+	} else {
+		compileArgs.push(...creExports.flatMap((p) => ['--cre-exports', path.resolve(p)]))
+	}
+	compileArgs.push(resolvedInput, resolvedOutput)
+
+	let javyPluginRoot: string
+	if (process.env.CRE_SDK_JAVY_PLUGIN_HOME) {
+		javyPluginRoot = path.resolve(process.env.CRE_SDK_JAVY_PLUGIN_HOME)
+	} else {
+		try {
+			javyPluginRoot = path.dirname(require.resolve('@chainlink/cre-sdk-javy-plugin/package.json'))
+		} catch {
+			javyPluginRoot = path.resolve(import.meta.dir, '../../../cre-sdk-javy-plugin')
+		}
+	}
+	const compilerPath = path.join(javyPluginRoot, 'bin/compile-workflow.ts')
 	if (existsSync(compilerPath)) {
-		await runBun(['--bun', compilerPath, resolvedInput, resolvedOutput])
+		await runBun(['--bun', compilerPath, ...compileArgs])
 	} else {
-		await runBun(['x', 'cre-compile-workflow', resolvedInput, resolvedOutput])
+		await runBun(['x', 'cre-compile-workflow', ...compileArgs])
 	}
 
 	console.info(`✅ Compiled: ${resolvedOutput}`)

package/scripts/src/compile-workflow.ts

@@ -1,17 +1,20 @@
 import { existsSync } from 'node:fs'
 import { mkdir } from 'node:fs/promises'
 import path from 'node:path'
+import { parseCompileFlags } from '@chainlink/cre-sdk-javy-plugin/scripts/parse-compile-flags'
 import { parseCompileCliArgs, skipTypeChecksFlag } from './compile-cli-args'
 import { main as compileToJs } from './compile-to-js'
 import { main as compileToWasm } from './compile-to-wasm'
 
 type CompileWorkflowOptions = {
 	skipTypeChecks?: boolean
+	creExports?: string[]
+	plugin?: string | null
 }
 
 const printUsage = () => {
 	console.error(
-		`Usage: bun compile:workflow <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`,
+		`Usage: bun compile:workflow [--plugin <path>] [--cre-exports <crate-dir>]... <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`,
 	)
 	console.error('Examples:')
 	console.error('  bun compile:workflow src/standard_tests/secrets/test.ts')
@@ -31,17 +34,25 @@ export const main = async (
 	let parsedInputPath: string | undefined
 	let parsedOutputPath: string | undefined
 	let parsedSkipTypeChecks = false
+	let parsedCreExports: string[] = []
+	let parsedPlugin: string | null = null
 
-	if (inputFile != null || outputWasmFile != null || options?.skipTypeChecks != null) {
+	if (inputFile != null || outputWasmFile != null || options != null) {
 		parsedInputPath = inputFile
 		parsedOutputPath = outputWasmFile
 		parsedSkipTypeChecks = options?.skipTypeChecks ?? false
+		parsedCreExports = options?.creExports ?? []
+		parsedPlugin = options?.plugin !== undefined ? options.plugin : null
 	} else {
 		try {
-			const parsed = parseCompileCliArgs(process.argv.slice(3))
+			const cliArgs = process.argv.slice(3)
+			const { creExports, plugin, rest } = parseCompileFlags(cliArgs)
+			const parsed = parseCompileCliArgs(rest)
 			parsedInputPath = parsed.inputPath
 			parsedOutputPath = parsed.outputPath
 			parsedSkipTypeChecks = parsed.skipTypeChecks
+			parsedCreExports = creExports
+			parsedPlugin = plugin
 		} catch (error) {
 			console.error(error instanceof Error ? error.message : error)
 			printUsage()
@@ -52,6 +63,11 @@ export const main = async (
 	const inputPath = parsedInputPath
 	const outputPathArg = parsedOutputPath
 
+	if (parsedPlugin != null && parsedPlugin !== '' && parsedCreExports.length > 0) {
+		console.error('❌ Error: --plugin and --cre-exports are mutually exclusive.')
+		process.exit(1)
+	}
+
 	if (!inputPath) {
 		printUsage()
 		process.exit(1)
@@ -63,33 +79,36 @@ export const main = async (
 		process.exit(1)
 	}
 
-	// Default final output = same dir, same basename, .wasm
 	const defaultWasmOut = path.join(
 		path.dirname(resolvedInput),
 		path.basename(resolvedInput).replace(/\.[^.]+$/, '.wasm'),
 	)
 	const resolvedWasmOutput = outputPathArg ? path.resolve(outputPathArg) : defaultWasmOut
-
-	// Put the intermediate JS next to the final wasm (so custom outputs stay together)
 	const resolvedJsOutput = resolvedWasmOutput.replace(/\.wasm$/i, '.js')
 
-	// Ensure directories exist (handles both intermediate JS dir and wasm dir)
 	await mkdir(path.dirname(resolvedJsOutput), { recursive: true })
 
-	console.info(`🚀 Compiling workflow`)
-	console.info(`📁 Input:   ${resolvedInput}\n`)
+	console.info('🚀 Compiling workflow')
+	console.info(`📁 Input:   ${resolvedInput}`)
+	console.info(`🧪 JS out:  ${resolvedJsOutput}`)
+	console.info(`🎯 WASM out:${resolvedWasmOutput}\n`)
 	if (parsedSkipTypeChecks) {
 		console.info(`⚠️  Skipping TypeScript checks (${skipTypeChecksFlag})`)
 	}
 
-	// Step 1: TS/JS → JS (bundled)
 	console.info('📦 Step 1: Compiling JS...')
 	await compileToJs(resolvedInput, resolvedJsOutput, { skipTypeChecks: parsedSkipTypeChecks })
 
-	// Step 2: JS → WASM
 	console.info('\n🔨 Step 2: Compiling to WASM...')
-	await compileToWasm(resolvedJsOutput, resolvedWasmOutput)
+	await compileToWasm(resolvedJsOutput, resolvedWasmOutput, parsedCreExports, parsedPlugin)
 
 	console.info(`\n✅ Workflow built: ${resolvedWasmOutput}`)
 	return resolvedWasmOutput
 }
+
+if (import.meta.main) {
+	main().catch((e) => {
+		console.error(e)
+		process.exit(1)
+	})
+}