@sentio/runtime 3.1.0-rc.4 → 3.2.0-rc.1

package/lib/index.d.ts

@@ -698,8 +698,52 @@ declare class ProcessorServiceImpl implements ProcessorServiceImplementation {
 }
 declare function recordRuntimeInfo(results: ProcessResult, handlerType: HandlerType): void;
 
+/**
+ * Configuration for the in-memory cache feature.
+ *
+ * The cache provides a key-value store that persists across handler invocations,
+ * allowing processors to store and retrieve computed values efficiently.
+ */
+interface CacheConfig {
+    /**
+     * Whether the cache feature is enabled.
+     * When enabled, a MemoryCacheItem entity will be automatically added to the schema.
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Maximum size of the cache in megabytes.
+     * Controls the memory limit for cached items.
+     * @default 100
+     */
+    size?: number;
+}
+/**
+ * Global configuration for the Sentio SDK runtime.
+ *
+ * This configuration controls execution behavior and optional features like caching.
+ * Settings here apply globally to all processors in the project.
+ */
 interface GlobalConfig {
+    /**
+     * Execution configuration controlling how handlers are processed.
+     * Includes settings for sequential vs parallel execution, block time handling, etc.
+     */
     execution: Partial<ExecutionConfig>;
+    /**
+     * Optional cache configuration for enabling in-memory key-value storage.
+     * When enabled, processors can use `ctx.cache` to store and retrieve values.
+     *
+     * @example
+     * ```typescript
+     * // In your processor handler:
+     * const cachedValue = await ctx.cache.get<number>('myKey')
+     * if (!cachedValue) {
+     *   await ctx.cache.set('myKey', computedValue)
+     * }
+     * ```
+     */
+    cache?: CacheConfig;
 }
 declare const GLOBAL_CONFIG: GlobalConfig;
 

package/lib/index.js

@@ -24,7 +24,7 @@ import {
   providerMetrics,
   recordRuntimeInfo,
   timeoutError
-} from "./chunk-TYDHN4Z6.js";
+} from "./chunk-G6JGZJP4.js";
 import {
   Plugin,
   PluginManager

package/lib/processor-runner.js

@@ -20,7 +20,7 @@ import {
   require_lib3,
   require_src,
   withAbort
-} from "./chunk-TYDHN4Z6.js";
+} from "./chunk-G6JGZJP4.js";
 import {
   ExecutionConfig,
   HandlerType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentio/runtime",
-  "version": "3.1.0-rc.4",
+  "version": "3.2.0-rc.1",
   "license": "Apache-2.0",
   "type": "module",
   "exports": {

package/src/global-config.ts

@@ -1,7 +1,54 @@
 import { ExecutionConfig } from './gen/processor/protos/processor.js'
 
+/**
+ * Configuration for the in-memory cache feature.
+ *
+ * The cache provides a key-value store that persists across handler invocations,
+ * allowing processors to store and retrieve computed values efficiently.
+ */
+export interface CacheConfig {
+  /**
+   * Whether the cache feature is enabled.
+   * When enabled, a MemoryCacheItem entity will be automatically added to the schema.
+   * @default true
+   */
+  enabled: boolean
+
+  /**
+   * Maximum size of the cache in megabytes.
+   * Controls the memory limit for cached items.
+   * @default 100
+   */
+  size?: number
+}
+
+/**
+ * Global configuration for the Sentio SDK runtime.
+ *
+ * This configuration controls execution behavior and optional features like caching.
+ * Settings here apply globally to all processors in the project.
+ */
 export interface GlobalConfig {
+  /**
+   * Execution configuration controlling how handlers are processed.
+   * Includes settings for sequential vs parallel execution, block time handling, etc.
+   */
   execution: Partial<ExecutionConfig>
+
+  /**
+   * Optional cache configuration for enabling in-memory key-value storage.
+   * When enabled, processors can use `ctx.cache` to store and retrieve values.
+   *
+   * @example
+   * ```typescript
+   * // In your processor handler:
+   * const cachedValue = await ctx.cache.get<number>('myKey')
+   * if (!cachedValue) {
+   *   await ctx.cache.set('myKey', computedValue)
+   * }
+   * ```
+   */
+  cache?: CacheConfig
 }
 
 // Experimental global config, only apply to eth for now
@@ -9,6 +56,9 @@ export const GLOBAL_CONFIG: GlobalConfig = {
   execution: {
     sequential: false,
     forceExactBlockTime: false
+  },
+  cache: {
+    enabled: true
   }
 }