@chainlink/cre-sdk 1.5.0 → 1.6.0-alpha.2

package/README.md

@@ -58,16 +58,10 @@ CRE workflows are compiled to WASM and executed through Javy (QuickJS). This is
 
 - 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 typechecks your workflow project first (using your nearest `tsconfig.json`), then validates workflow source and fails fast when unsupported APIs are used.
+- `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.
 
-If you need to compile despite TypeScript errors, pass `--skip-type-checks`:
-
-```bash
-bun x cre-compile src/workflow.ts dist/workflow.wasm --skip-type-checks
-```
-
 ## 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/bin/cre-compile.ts

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

package/dist/sdk/don-info.d.ts

@@ -0,0 +1,10 @@
+export type Environment = {
+    chainSelector: bigint;
+    registryAddress: string;
+};
+export type Zone = {
+    environment: Environment;
+    donID: number;
+};
+export declare function productionEnvironment(): Environment;
+export declare function zoneFromEnvironment(environment: Environment, donID: number): Zone;

package/dist/sdk/don-info.js

@@ -0,0 +1,9 @@
+export function productionEnvironment() {
+    return {
+        chainSelector: 5009297550715157269n,
+        registryAddress: '0x76c9cf548b4179F8901cda1f8623568b58215E62',
+    };
+}
+export function zoneFromEnvironment(environment, donID) {
+    return { environment, donID };
+}

package/dist/sdk/errors.d.ts

@@ -1,4 +1,4 @@
-import { type SecretRequest } from '../generated/sdk/v1alpha/sdk_pb';
+import type { SecretRequest } from '../generated/sdk/v1alpha/sdk_pb';
 export declare class DonModeError extends Error {
     constructor();
 }
@@ -10,3 +10,26 @@ export declare class SecretsError extends Error {
     error: string;
     constructor(secretRequest: SecretRequest, error: string);
 }
+export declare class NullReportError extends Error {
+    constructor();
+}
+export declare class WrongSignatureCountError extends Error {
+    constructor();
+}
+export declare class ParseSignatureError extends Error {
+    constructor();
+}
+export declare class RecoverSignerError extends Error {
+    constructor();
+}
+export declare class UnknownSignerError extends Error {
+    constructor();
+}
+export declare class DuplicateSignerError extends Error {
+    constructor();
+}
+export declare class RawReportTooShortError extends Error {
+    readonly need: number;
+    readonly got: number;
+    constructor(need: number, got: number);
+}

package/dist/sdk/errors.js

@@ -1,4 +1,3 @@
-import { Mode } from '../generated/sdk/v1alpha/sdk_pb';
 export class DonModeError extends Error {
     constructor() {
         super('cannot use Runtime inside RunInNodeMode');
@@ -21,3 +20,49 @@ export class SecretsError extends Error {
         this.name = 'SecretsError';
     }
 }
+export class NullReportError extends Error {
+    constructor() {
+        super('null report');
+        this.name = 'NullReportError';
+    }
+}
+export class WrongSignatureCountError extends Error {
+    constructor() {
+        super('wrong number of signatures');
+        this.name = 'WrongSignatureCountError';
+    }
+}
+export class ParseSignatureError extends Error {
+    constructor() {
+        super('failed to parse signature');
+        this.name = 'ParseSignatureError';
+    }
+}
+export class RecoverSignerError extends Error {
+    constructor() {
+        super('failed to recover signer address from signature');
+        this.name = 'RecoverSignerError';
+    }
+}
+export class UnknownSignerError extends Error {
+    constructor() {
+        super('invalid signature');
+        this.name = 'UnknownSignerError';
+    }
+}
+export class DuplicateSignerError extends Error {
+    constructor() {
+        super('duplicate signer');
+        this.name = 'DuplicateSignerError';
+    }
+}
+export class RawReportTooShortError extends Error {
+    need;
+    got;
+    constructor(need, got) {
+        super(`raw report too short to contain metadata header: need ${need} bytes, got ${got}`);
+        this.need = need;
+        this.got = got;
+        this.name = 'RawReportTooShortError';
+    }
+}

package/dist/sdk/index.d.ts

@@ -1,4 +1,6 @@
 export * from './cre';
+export * from './don-info';
+export * from './errors';
 export * from './report';
 export type * from './runtime';
 export * from './runtime';

package/dist/sdk/index.js

@@ -1,4 +1,6 @@
 export * from './cre';
+export * from './don-info';
+export * from './errors';
 export * from './report';
 export * from './runtime';
 export * from './types/bufbuild-types';

package/dist/sdk/report-internals.d.ts

@@ -0,0 +1,6 @@
+import type { Address } from 'viem';
+export type DonInfo = {
+    f: number;
+    signers: Map<Address, number>;
+};
+export declare var donInfoCache: Map<string, DonInfo>;

package/dist/sdk/report-internals.js

@@ -0,0 +1,3 @@
+// Do not re-export in index.ts to avoid exposing it to the public API.
+// donInfoCache exists outside Report to allow testing to clear the cache.
+export var donInfoCache = new Map();

package/dist/sdk/report.d.ts

@@ -1,6 +1,44 @@
 import { type ReportResponse, type ReportResponseJson } from '../generated/sdk/v1alpha/sdk_pb';
+import { type Environment, type Zone } from './don-info';
+import type { BaseRuntime } from './runtime';
+export type ReportParseConfig = {
+    acceptedZones?: Zone[];
+    acceptedEnvironments?: Environment[];
+    skipSignatureVerification?: boolean;
+};
+export declare const REPORT_METADATA_HEADER_LENGTH = 109;
+export type ReportMetadataHeader = {
+    version: number;
+    executionId: string;
+    timestamp: number;
+    donId: number;
+    donConfigVersion: number;
+    workflowId: string;
+    workflowName: string;
+    workflowOwner: string;
+    reportId: string;
+    body: Uint8Array;
+};
 export declare class Report {
     private readonly report;
+    private cachedHeader;
     constructor(report: ReportResponse | ReportResponseJson);
+    static parse(runtime: BaseRuntime<unknown>, rawReport: Uint8Array, signatures: Uint8Array[], reportContext: Uint8Array, config?: ReportParseConfig): Promise<Report>;
+    private parseHeader;
+    private verifySignaturesWithConfig;
+    seqNr(): bigint;
+    configDigest(): Uint8Array;
+    reportContext(): Uint8Array;
+    rawReport(): Uint8Array;
+    version(): number;
+    executionId(): string;
+    timestamp(): number;
+    donId(): number;
+    donConfigVersion(): number;
+    workflowId(): string;
+    workflowName(): string;
+    workflowOwner(): string;
+    reportId(): string;
+    body(): Uint8Array;
     x_generatedCodeOnly_unwrap(): ReportResponse;
 }