|
| 1 | +export * from './sdk'; |
| 2 | +export * as EVM_PB from '@cre/generated/capabilities/blockchain/evm/v1alpha/client_pb'; |
| 3 | +export * as SOLANA_PB from '@cre/generated/capabilities/blockchain/solana/v1alpha/client_pb'; |
| 4 | +export * as CONFIDENTIAL_HTTP_CLIENT_PB from '@cre/generated/capabilities/networking/confidentialhttp/v1alpha/client_pb'; |
| 5 | +export * as HTTP_CLIENT_PB from '@cre/generated/capabilities/networking/http/v1alpha/client_pb'; |
| 6 | +export * as HTTP_TRIGGER_PB from '@cre/generated/capabilities/networking/http/v1alpha/trigger_pb'; |
| 7 | +export * as CRON_TRIGGER_PB from '@cre/generated/capabilities/scheduler/cron/v1/trigger_pb'; |
| 8 | +export * as SDK_PB from '@cre/generated/sdk/v1alpha/sdk_pb'; |
| 9 | +export * as VALUES_PB from '@cre/generated/values/v1/values_pb'; |
| 10 | +export * as BUFBUILD_TYPES from '@cre/sdk/types/bufbuild-types'; |
| 11 | +export * from './cre'; |
| 12 | +export * from './don-info'; |
| 13 | +export * from './errors'; |
| 14 | +export * from './report'; |
| 15 | +export type * from './runtime'; |
| 16 | +export * from './runtime'; |
| 17 | +export * from './types/bufbuild-types'; |
| 18 | +export * from './utils'; |
| 19 | +export * from './utils/capabilities/http/http-helpers'; |
| 20 | +export * from './wasm'; |
| 21 | +export * from './workflow'; |
| 22 | +import type { Message } from '@bufbuild/protobuf'; |
| 23 | +import type { GenMessage } from '@bufbuild/protobuf/codegenv2'; |
| 24 | +import type { ReportRequest, ReportRequestJson } from '@cre/generated/sdk/v1alpha/sdk_pb'; |
| 25 | +import type { Report } from '@cre/sdk/report'; |
| 26 | +import type { ConsensusAggregation, PrimitiveTypes, UnwrapOptions } from '@cre/sdk/utils'; |
| 27 | +import type { SecretsProvider } from '.'; |
| 28 | +export type { ReportRequest, ReportRequestJson }; |
| 29 | +export type CallCapabilityParams<I extends Message, O extends Message> = { |
| 30 | + capabilityId: string; |
| 31 | + method: string; |
| 32 | + payload: I; |
| 33 | + inputSchema: GenMessage<I>; |
| 34 | + outputSchema: GenMessage<O>; |
| 35 | +}; |
| 36 | +/** |
| 37 | + * Base runtime available in both DON and Node execution modes. |
| 38 | + * Provides core functionality for calling capabilities and logging. |
| 39 | + */ |
| 40 | +export interface BaseRuntime<C> { |
| 41 | + config: C; |
| 42 | + callCapability<I extends Message, O extends Message>(params: CallCapabilityParams<I, O>): { |
| 43 | + result: () => O; |
| 44 | + }; |
| 45 | + now(): Date; |
| 46 | + log(message: string): void; |
| 47 | +} |
| 48 | +/** |
| 49 | + * Runtime for Node mode execution. |
| 50 | + */ |
| 51 | +export interface NodeRuntime<C> extends BaseRuntime<C> { |
| 52 | + readonly _isNodeRuntime: true; |
| 53 | +} |
| 54 | +/** |
| 55 | + * Runtime for DON mode execution. |
| 56 | + */ |
| 57 | +export interface Runtime<C> extends BaseRuntime<C>, SecretsProvider { |
| 58 | + /** |
| 59 | + * Executes a function in Node mode and aggregates results via consensus. |
| 60 | + * |
| 61 | + * @param fn - Function to execute in each node (receives NodeRuntime) |
| 62 | + * @param consensusAggregation - How to aggregate results across nodes |
| 63 | + * @param unwrapOptions - Optional unwrapping config for complex return types |
| 64 | + * @returns Wrapped function that returns aggregated result |
| 65 | + */ |
| 66 | + runInNodeMode<TArgs extends unknown[], TOutput>(fn: (nodeRuntime: NodeRuntime<C>, ...args: TArgs) => TOutput, consensusAggregation: ConsensusAggregation<TOutput, true>, unwrapOptions?: TOutput extends PrimitiveTypes ? never : UnwrapOptions<TOutput>): (...args: TArgs) => { |
| 67 | + result: () => TOutput; |
| 68 | + }; |
| 69 | + report(input: ReportRequest | ReportRequestJson): { |
| 70 | + result: () => Report; |
| 71 | + }; |
| 72 | +} |
| 73 | +import type { Message } from '@bufbuild/protobuf'; |
| 74 | +import type { Secret, SecretRequest, SecretRequestJson } from '@cre/generated/sdk/v1alpha/sdk_pb'; |
| 75 | +import { type Runtime } from '@cre/sdk/runtime'; |
| 76 | +import type { Trigger } from '@cre/sdk/utils/triggers/trigger-interface'; |
| 77 | +import type { CreSerializable } from './utils'; |
| 78 | +export type HandlerFn<TConfig, TTriggerOutput, TResult> = (runtime: Runtime<TConfig>, triggerOutput: TTriggerOutput) => Promise<CreSerializable<TResult>> | CreSerializable<TResult>; |
| 79 | +export interface HandlerEntry<TConfig, TRawTriggerOutput extends Message<string>, TTriggerOutput, TResult> { |
| 80 | + trigger: Trigger<TRawTriggerOutput, TTriggerOutput>; |
| 81 | + fn: HandlerFn<TConfig, TTriggerOutput, TResult>; |
| 82 | +} |
| 83 | +export type Workflow<TConfig> = ReadonlyArray<HandlerEntry<TConfig, any, any, any>>; |
| 84 | +export declare const handler: <TRawTriggerOutput extends Message<string>, TTriggerOutput, TConfig, TResult>(trigger: Trigger<TRawTriggerOutput, TTriggerOutput>, fn: HandlerFn<TConfig, TTriggerOutput, TResult>) => HandlerEntry<TConfig, TRawTriggerOutput, TTriggerOutput, TResult>; |
| 85 | +export type SecretsProvider = { |
| 86 | + getSecret(request: SecretRequest | SecretRequestJson): { |
| 87 | + result: () => Secret; |
| 88 | + }; |
| 89 | +}; |
| 90 | +import type { SecretRequest } from '@cre/generated/sdk/v1alpha/sdk_pb'; |
| 91 | +export declare class DonModeError extends Error { |
| 92 | + constructor(); |
| 93 | +} |
| 94 | +export declare class NodeModeError extends Error { |
| 95 | + constructor(); |
| 96 | +} |
| 97 | +export declare class SecretsError extends Error { |
| 98 | + secretRequest: SecretRequest; |
| 99 | + error: string; |
| 100 | + constructor(secretRequest: SecretRequest, error: string); |
| 101 | +} |
| 102 | +export declare class NullReportError extends Error { |
| 103 | + constructor(); |
| 104 | +} |
| 105 | +export declare class WrongSignatureCountError extends Error { |
| 106 | + constructor(); |
| 107 | +} |
| 108 | +export declare class ParseSignatureError extends Error { |
| 109 | + constructor(); |
| 110 | +} |
| 111 | +export declare class RecoverSignerError extends Error { |
| 112 | + constructor(); |
| 113 | +} |
| 114 | +export declare class UnknownSignerError extends Error { |
| 115 | + constructor(); |
| 116 | +} |
| 117 | +export declare class DuplicateSignerError extends Error { |
| 118 | + constructor(); |
| 119 | +} |
| 120 | +export declare class RawReportTooShortError extends Error { |
| 121 | + readonly need: number; |
| 122 | + readonly got: number; |
| 123 | + constructor(need: number, got: number); |
| 124 | +} |
| 125 | +import { type ReportResponse, type ReportResponseJson } from '@cre/generated/sdk/v1alpha/sdk_pb'; |
| 126 | +import { type Environment, type Zone } from './don-info'; |
| 127 | +import type { BaseRuntime } from './runtime'; |
| 128 | +export type ReportParseConfig = { |
| 129 | + acceptedZones?: Zone[]; |
| 130 | + acceptedEnvironments?: Environment[]; |
| 131 | + skipSignatureVerification?: boolean; |
| 132 | +}; |
| 133 | +export declare const REPORT_METADATA_HEADER_LENGTH = 109; |
| 134 | +export type ReportMetadataHeader = { |
| 135 | + version: number; |
| 136 | + executionId: string; |
| 137 | + timestamp: number; |
| 138 | + donId: number; |
| 139 | + donConfigVersion: number; |
| 140 | + workflowId: string; |
| 141 | + workflowName: string; |
| 142 | + workflowOwner: string; |
| 143 | + reportId: string; |
| 144 | + body: Uint8Array; |
| 145 | +}; |
| 146 | +export declare class Report { |
| 147 | + private readonly report; |
| 148 | + private cachedHeader; |
| 149 | + constructor(report: ReportResponse | ReportResponseJson); |
| 150 | + static parse(runtime: BaseRuntime<unknown>, rawReport: Uint8Array, signatures: Uint8Array[], reportContext: Uint8Array, config?: ReportParseConfig): Promise<Report>; |
| 151 | + private parseHeader; |
| 152 | + private verifySignaturesWithConfig; |
| 153 | + seqNr(): bigint; |
| 154 | + configDigest(): Uint8Array; |
| 155 | + reportContext(): Uint8Array; |
| 156 | + rawReport(): Uint8Array; |
| 157 | + version(): number; |
| 158 | + executionId(): string; |
| 159 | + timestamp(): number; |
| 160 | + donId(): number; |
| 161 | + donConfigVersion(): number; |
| 162 | + workflowId(): string; |
| 163 | + workflowName(): string; |
| 164 | + workflowOwner(): string; |
| 165 | + reportId(): string; |
| 166 | + body(): Uint8Array; |
| 167 | + x_generatedCodeOnly_unwrap(): ReportResponse; |
| 168 | +} |
| 169 | +/** |
| 170 | + * Test-only surface for the CRE SDK: test framework and (when generated) capability mocks. |
| 171 | + * Use for unit testing runtime logic without the WASM execution environment. |
| 172 | + */ |
| 173 | +export { type CapabilityHandler, DEFAULT_MAX_RESPONSE_SIZE_BYTES, getTestCapabilityHandler, type NewTestRuntimeOptions, newTestRuntime, REPORT_METADATA_HEADER_LENGTH, RESPONSE_BUFFER_TOO_SMALL, registerTestCapability, type Secrets, TestRuntime, type TestRuntimeState, test, } from '../testutils/test-runtime'; |
| 174 | +export { TestWriter } from '../testutils/test-writer'; |
| 175 | +export { type AddContractMockOptions, addContractMock, type ContractMock, type WriteReportMockInput, } from './evm-contract-mock'; |
| 176 | +export * from './generated'; |
0 commit comments