@elizaos/core 1.5.4 → 1.5.5

package/src/types/service.ts

@@ -1,198 +0,0 @@
-import type { Metadata } from './primitives';
-import type { IAgentRuntime } from './runtime';
-
-/**
- * Core service type registry that can be extended by plugins via module augmentation.
- * Plugins can extend this interface to add their own service types:
- *
- * @example
- * ```typescript
- * declare module '@elizaos/core' {
- *   interface ServiceTypeRegistry {
- *     MY_CUSTOM_SERVICE: 'my_custom_service';
- *   }
- * }
- * ```
- */
-export interface ServiceTypeRegistry {
-  TRANSCRIPTION: 'transcription';
-  VIDEO: 'video';
-  BROWSER: 'browser';
-  PDF: 'pdf';
-  REMOTE_FILES: 'aws_s3';
-  WEB_SEARCH: 'web_search';
-  EMAIL: 'email';
-  TEE: 'tee';
-  TASK: 'task';
-  WALLET: 'wallet';
-  LP_POOL: 'lp_pool';
-  TOKEN_DATA: 'token_data';
-  MESSAGE: 'message';
-  POST: 'post';
-  UNKNOWN: 'unknown';
-}
-
-/**
- * Type for service names that includes both core services and any plugin-registered services
- */
-export type ServiceTypeName = ServiceTypeRegistry[keyof ServiceTypeRegistry];
-
-/**
- * Helper type to extract service type values from the registry
- */
-export type ServiceTypeValue<K extends keyof ServiceTypeRegistry> = ServiceTypeRegistry[K];
-
-/**
- * Helper type to check if a service type exists in the registry
- */
-export type IsValidServiceType<T extends string> = T extends ServiceTypeName ? true : false;
-
-/**
- * Type-safe service class definition
- */
-export type TypedServiceClass<T extends ServiceTypeName> = {
-  new (runtime?: IAgentRuntime): Service;
-  serviceType: T;
-  start(runtime: IAgentRuntime): Promise<Service>;
-};
-
-/**
- * Map of service type names to their implementation classes
- */
-export interface ServiceClassMap {
-  // Core services will be added here, plugins extend via module augmentation
-}
-
-/**
- * Helper to infer service instance type from service type name
- */
-export type ServiceInstance<T extends ServiceTypeName> = T extends keyof ServiceClassMap
-  ? InstanceType<ServiceClassMap[T]>
-  : Service;
-
-/**
- * Runtime service registry type
- */
-export type ServiceRegistry<T extends ServiceTypeName = ServiceTypeName> = Map<T, Service>;
-
-/**
- * Enumerates the recognized types of services that can be registered and used by the agent runtime.
- * Services provide specialized functionalities like audio transcription, video processing,
- * web browsing, PDF handling, file storage (e.g., AWS S3), web search, email integration,
- * secure execution via TEE (Trusted Execution Environment), and task management.
- * This constant is used in `AgentRuntime` for service registration and retrieval (e.g., `getService`).
- * Each service typically implements the `Service` abstract class or a more specific interface like `IVideoService`.
- */
-export const ServiceType = {
-  TRANSCRIPTION: 'transcription',
-  VIDEO: 'video',
-  BROWSER: 'browser',
-  PDF: 'pdf',
-  REMOTE_FILES: 'aws_s3',
-  WEB_SEARCH: 'web_search',
-  EMAIL: 'email',
-  TEE: 'tee',
-  TASK: 'task',
-  WALLET: 'wallet',
-  LP_POOL: 'lp_pool',
-  TOKEN_DATA: 'token_data',
-  MESSAGE: 'message',
-  POST: 'post',
-  UNKNOWN: 'unknown',
-} as const satisfies ServiceTypeRegistry;
-
-/**
- * Client instance
- */
-export abstract class Service {
-  /** Runtime instance */
-  protected runtime!: IAgentRuntime;
-
-  constructor(runtime?: IAgentRuntime) {
-    if (runtime) {
-      this.runtime = runtime;
-    }
-  }
-
-  abstract stop(): Promise<void>;
-
-  /** Service type */
-  static serviceType: string;
-
-  /** Service name */
-  abstract capabilityDescription: string;
-
-  /** Service configuration */
-  config?: Metadata;
-
-  /** Start service connection */
-  static async start(_runtime: IAgentRuntime): Promise<Service> {
-    throw new Error('Not implemented');
-  }
-
-  /** Stop service connection */
-  static async stop(_runtime: IAgentRuntime): Promise<unknown> {
-    throw new Error('Not implemented');
-  }
-}
-
-/**
- * Generic service interface that provides better type checking for services
- * @template ConfigType The configuration type for this service
- * @template ResultType The result type returned by the service operations
- */
-export interface TypedService<ConfigType extends Metadata = Metadata, ResultType = unknown>
-  extends Service {
-  /**
-   * The configuration for this service instance
-   */
-  config?: ConfigType;
-
-  /**
-   * Process an input with this service
-   * @param input The input to process
-   * @returns A promise resolving to the result
-   */
-  process(input: unknown): Promise<ResultType>;
-}
-
-/**
- * Generic factory function to create a typed service instance
- * @param runtime The agent runtime
- * @param serviceType The type of service to get
- * @returns The service instance or null if not available
- */
-export function getTypedService<T extends TypedService<any, any>>(
-  runtime: IAgentRuntime,
-  serviceType: ServiceTypeName
-): T | null {
-  return runtime.getService<T>(serviceType);
-}
-
-/**
- * Standardized service error type for consistent error handling
- */
-export interface ServiceError {
-  code: string;
-  message: string;
-  details?: unknown;
-  cause?: Error;
-}
-
-/**
- * Safely create a ServiceError from any caught error
- */
-export function createServiceError(error: unknown, code = 'UNKNOWN_ERROR'): ServiceError {
-  if (error instanceof Error) {
-    return {
-      code,
-      message: error.message,
-      cause: error,
-    };
-  }
-
-  return {
-    code,
-    message: String(error),
-  };
-}

package/src/types/settings.ts

@@ -1,30 +0,0 @@
-/**
- * Interface representing settings with string key-value pairs.
- */
-export interface RuntimeSettings {
-  [key: string]: string | undefined;
-}
-
-export interface Setting {
-  name: string;
-  description: string; // Used in chat context when discussing the setting
-  usageDescription: string; // Used during settings to guide users
-  value: string | boolean | null;
-  required: boolean;
-  public?: boolean; // If true, shown in public channels
-  secret?: boolean; // If true, value is masked and only shown during settings
-  validation?: (value: any) => boolean;
-  dependsOn?: string[];
-  onSetAction?: (value: any) => string;
-  visibleIf?: (settings: { [key: string]: Setting }) => boolean;
-}
-
-export interface WorldSettings {
-  [key: string]: Setting;
-}
-
-export interface OnboardingConfig {
-  settings: {
-    [key: string]: Omit<Setting, 'value'>;
-  };
-}

package/src/types/state.ts

@@ -1,60 +0,0 @@
-/**
- * Represents the current state or context of a conversation or agent interaction.
- * This interface is a flexible container for various pieces of information that define the agent's
- * understanding at a point in time. It includes:
- * - `values`: A key-value store for general state variables, often populated by providers.
- * - `data`: Another key-value store, potentially for more structured or internal data.
- * - `text`: A string representation of the current context, often a summary or concatenated history.
- * The `[key: string]: any;` allows for dynamic properties, though `EnhancedState` offers better typing.
- * This state object is passed to handlers for actions, evaluators, and providers.
- */
-export interface State {
-  /** Additional dynamic properties */
-  [key: string]: any;
-  values: {
-    [key: string]: any;
-  };
-  data: {
-    [key: string]: any;
-  };
-  text: string;
-}
-
-/**
- * Defines the possible primitive types or structured types for a value within the agent's state.
- * This type is used to provide more specific typing for properties within `StateObject` and `StateArray`,
- * moving away from a generic 'any' type for better type safety and clarity in state management.
- */
-export type StateValue = string | number | boolean | null | StateObject | StateArray;
-/**
- * Represents a generic object structure within the agent's state, where keys are strings
- * and values can be any `StateValue`. This allows for nested objects within the state.
- * It's a fundamental part of the `EnhancedState` interface.
- */
-export interface StateObject {
-  [key: string]: StateValue;
-}
-/**
- * Represents an array of `StateValue` types within the agent's state.
- * This allows for lists of mixed or uniform types to be stored in the state,
- * contributing to the structured definition of `EnhancedState`.
- */
-export type StateArray = StateValue[];
-
-/**
- * Enhanced State interface with more specific types for its core properties.
- * This interface provides a more structured representation of an agent's conversational state,
- * building upon the base `State` by typing `values` and `data` as `StateObject`.
- * The `text` property typically holds a textual summary or context derived from the state.
- * Additional dynamic properties are still allowed via the index signature `[key: string]: StateValue;`.
- */
-export interface EnhancedState {
-  /** Holds directly accessible state values, often used for template rendering or quick lookups. */
-  values: StateObject;
-  /** Stores more complex or structured data, potentially namespaced by providers or internal systems. */
-  data: StateObject;
-  /** A textual representation or summary of the current state, often used as context for models. */
-  text: string;
-  /** Allows for additional dynamic properties to be added to the state object. */
-  [key: string]: StateValue;
-}

package/src/types/task.ts

@@ -1,72 +0,0 @@
-import type { Memory } from './memory';
-import type { UUID } from './primitives';
-import type { IAgentRuntime } from './runtime';
-import type { State } from './state';
-
-/**
- * Defines the contract for a Task Worker, which is responsible for executing a specific type of task.
- * Task workers are registered with the `AgentRuntime` and are invoked when a `Task` of their designated `name` needs processing.
- * This pattern allows for modular and extensible background task processing.
- */
-export interface TaskWorker {
-  /** The unique name of the task type this worker handles. This name links `Task` instances to this worker. */
-  name: string;
-  /**
-   * The core execution logic for the task. This function is called by the runtime when a task needs to be processed.
-   * It receives the `AgentRuntime`, task-specific `options`, and the `Task` object itself.
-   */
-  execute: (
-    runtime: IAgentRuntime,
-    options: { [key: string]: unknown },
-    task: Task
-  ) => Promise<void>;
-  /**
-   * Optional validation function that can be used to determine if a task is valid or should be executed,
-   * often based on the current message and state. This might be used by an action or evaluator
-   * before creating or queueing a task.
-   */
-  validate?: (runtime: IAgentRuntime, message: Memory, state: State) => Promise<boolean>;
-}
-
-/**
- * Defines metadata associated with a `Task`.
- * This can include scheduling information like `updateInterval` or UI-related details
- * for presenting task options to a user.
- * The `[key: string]: unknown;` allows for additional, unspecified metadata fields.
- */
-export type TaskMetadata = {
-  /** Optional. If the task is recurring, this specifies the interval in milliseconds between updates or executions. */
-  updateInterval?: number;
-  /** Optional. Describes options or parameters that can be configured for this task, often for UI presentation. */
-  options?: {
-    name: string;
-    description: string;
-  }[];
-  /** Allows for other dynamic metadata properties related to the task. */
-  [key: string]: unknown;
-};
-
-/**
- * Represents a task to be performed, often in the background or at a later time.
- * Tasks are managed by the `AgentRuntime` and processed by registered `TaskWorker`s.
- * They can be associated with a room, world, and tagged for categorization and retrieval.
- * The `IDatabaseAdapter` handles persistence of task data.
- */
-export interface Task {
-  /** Optional. A Universally Unique Identifier for the task. Generated if not provided. */
-  id?: UUID;
-  /** The name of the task, which should correspond to a registered `TaskWorker.name`. */
-  name: string;
-  /** Optional. Timestamp of the last update to this task. */
-  updatedAt?: number;
-  /** Optional. Metadata associated with the task, conforming to `TaskMetadata`. */
-  metadata?: TaskMetadata;
-  /** A human-readable description of what the task does or its purpose. */
-  description: string;
-  /** Optional. The UUID of the room this task is associated with. */
-  roomId?: UUID;
-  /** Optional. The UUID of the world this task is associated with. */
-  worldId?: UUID;
-  entityId?: UUID;
-  tags: string[];
-}

package/src/types/tee.ts

@@ -1,107 +0,0 @@
-import type { Metadata } from './primitives';
-
-// Represents an agent in the TeeAgent table, containing details about the agent.
-/**
- * Represents an agent's registration details within a Trusted Execution Environment (TEE) context.
- * This is typically stored in a database table (e.g., `TeeAgent`) to manage agents operating in a TEE.
- * It allows for multiple registrations of the same `agentId` to support scenarios where an agent might restart,
- * generating a new keypair and attestation each time.
- */
-export interface TeeAgent {
-  /** Primary key for the TEE agent registration record (e.g., a UUID or auto-incrementing ID). */
-  id: string; // Primary key
-  // Allow duplicate agentId.
-  // This is to support the case where the same agentId is registered multiple times.
-  // Each time the agent restarts, we will generate a new keypair and attestation.
-  /** The core identifier of the agent, which can be duplicated across multiple TEE registrations. */
-  agentId: string;
-  /** The human-readable name of the agent. */
-  agentName: string;
-  /** Timestamp (e.g., Unix epoch in milliseconds) when this TEE registration was created. */
-  createdAt: number;
-  /** The public key associated with this specific TEE agent instance/session. */
-  publicKey: string;
-  /** The attestation document proving the authenticity and integrity of the TEE instance. */
-  attestation: string;
-}
-
-/**
- * Defines the operational modes for a Trusted Execution Environment (TEE).
- * This enum is used to configure how TEE functionalities are engaged, allowing for
- * different setups for local development, Docker-based development, and production.
- */
-export enum TEEMode {
-  /** TEE functionality is completely disabled. */
-  OFF = 'OFF',
-  /** For local development, potentially using a TEE simulator. */
-  LOCAL = 'LOCAL', // For local development with simulator
-  /** For Docker-based development environments, possibly with a TEE simulator. */
-  DOCKER = 'DOCKER', // For docker development with simulator
-  /** For production deployments, using actual TEE hardware without a simulator. */
-  PRODUCTION = 'PRODUCTION', // For production without simulator
-}
-
-/**
- * Represents a quote obtained during remote attestation for a Trusted Execution Environment (TEE).
- * This quote is a piece of evidence provided by the TEE, cryptographically signed, which can be
- * verified by a relying party to ensure the TEE's integrity and authenticity.
- */
-export interface RemoteAttestationQuote {
-  /** The attestation quote data, typically a base64 encoded string or similar format. */
-  quote: string;
-  /** Timestamp (e.g., Unix epoch in milliseconds) when the quote was generated or received. */
-  timestamp: number;
-}
-
-/**
- * Data structure used in the attestation process for deriving a key within a Trusted Execution Environment (TEE).
- * This information helps establish a secure channel or verify the identity of the agent instance
- * requesting key derivation.
- */
-export interface DeriveKeyAttestationData {
-  /** The unique identifier of the agent for which the key derivation is being attested. */
-  agentId: string;
-  /** The public key of the agent instance involved in the key derivation process. */
-  publicKey: string;
-  /** Optional subject or context information related to the key derivation. */
-  subject?: string;
-}
-
-/**
- * Represents a message that has been attested by a Trusted Execution Environment (TEE).
- * This structure binds a message to an agent's identity and a timestamp, all within the
- * context of a remote attestation process, ensuring the message originated from a trusted TEE instance.
- */
-export interface RemoteAttestationMessage {
-  /** The unique identifier of the agent sending the attested message. */
-  agentId: string;
-  /** Timestamp (e.g., Unix epoch in milliseconds) when the message was attested or sent. */
-  timestamp: number;
-  /** The actual message content, including details about the entity, room, and the content itself. */
-  message: {
-    entityId: string;
-    roomId: string;
-    content: string;
-  };
-}
-
-/**
- * Enumerates different types or vendors of Trusted Execution Environments (TEEs).
- * This allows the system to adapt to specific TEE technologies, like Intel TDX on DSTACK.
- */
-export enum TeeType {
-  /** Represents Intel Trusted Domain Extensions (TDX) running on DSTACK infrastructure. */
-  TDX_DSTACK = 'tdx_dstack',
-}
-
-/**
- * Configuration for a TEE (Trusted Execution Environment) plugin.
- * This allows specifying the TEE vendor and any vendor-specific configurations.
- * It's used to initialize and configure TEE-related functionalities within the agent system.
- */
-export interface TeePluginConfig {
-  /** Optional. The name or identifier of the TEE vendor (e.g., 'tdx_dstack' from `TeeType`). */
-  vendor?: string;
-  /** Optional. Vendor-specific configuration options, conforming to `TeeVendorConfig`. */
-  vendorConfig?: Metadata;
-}

package/src/types/testing.ts

@@ -1,30 +0,0 @@
-import type { IAgentRuntime } from './runtime';
-
-/**
- * Represents a test case for evaluating agent or plugin functionality.
- * Each test case has a name and a function that contains the test logic.
- * The test function receives the `IAgentRuntime` instance, allowing it to interact with the agent's capabilities.
- * Test cases are typically grouped into `TestSuite`s.
- */
-export interface TestCase {
-  /** A descriptive name for the test case, e.g., "should respond to greetings". */
-  name: string;
-  /**
-   * The function that executes the test logic. It can be synchronous or asynchronous.
-   * It receives the `IAgentRuntime` to interact with the agent and its services.
-   * The function should typically contain assertions to verify expected outcomes.
-   */
-  fn: (runtime: IAgentRuntime) => Promise<void> | void;
-}
-
-/**
- * Represents a suite of related test cases for an agent or plugin.
- * This helps in organizing tests and running them collectively.
- * A `ProjectAgent` can define one or more `TestSuite`s.
- */
-export interface TestSuite {
-  /** A descriptive name for the test suite, e.g., "Core Functionality Tests". */
-  name: string;
-  /** An array of `TestCase` objects that belong to this suite. */
-  tests: TestCase[];
-}

package/src/types/token.ts

@@ -1,96 +0,0 @@
-import { Service, ServiceType } from './service';
-
-/**
- * A standardized representation of a token holding.
- */
-export interface TokenBalance {
-  address: string; // Token mint address, or a native identifier like 'SOL' or 'ETH'
-  balance: string; // Raw balance as a string to handle large numbers with precision
-  decimals: number;
-  uiAmount?: number; // User-friendly balance, adjusted for decimals
-  name?: string;
-  symbol?: string;
-  logoURI?: string;
-}
-
-/**
- * Generic representation of token data that can be provided by various services.
- */
-export interface TokenData {
-  id: string; // Unique identifier (e.g., contract address or a composite ID)
-  symbol: string;
-  name: string;
-  address: string; // Contract address
-  chain: string; // e.g., 'solana', 'ethereum', 'base'
-  sourceProvider: string; // e.g., 'birdeye', 'coinmarketcap'
-
-  price?: number;
-  priceChange24hPercent?: number;
-  priceChange24hUSD?: number; // Absolute change
-
-  volume24hUSD?: number;
-  marketCapUSD?: number;
-
-  liquidity?: number;
-  holders?: number;
-
-  logoURI?: string;
-  decimals?: number;
-
-  // Timestamps
-  lastUpdatedAt?: Date; // When this specific data point was last updated from the source
-
-  // Optional raw data from the provider
-  raw?: any;
-}
-
-/**
- * Interface for a generic service that provides token data.
- */
-export abstract class ITokenDataService extends Service {
-  static override readonly serviceType = ServiceType.TOKEN_DATA;
-  public readonly capabilityDescription =
-    'Provides standardized access to token market data.' as string;
-
-  /**
-   * Fetches detailed information for a single token.
-   * @param address The token's contract address.
-   * @param chain The blockchain the token resides on.
-   * @returns A Promise resolving to TokenData or null if not found.
-   */
-  abstract getTokenDetails(address: string, chain: string): Promise<TokenData | null>;
-
-  /**
-   * Fetches a list of trending tokens.
-   * @param chain Optional: Filter by a specific blockchain.
-   * @param limit Optional: Number of tokens to return. Defaults to a service-specific value.
-   * @param timePeriod Optional: Time period for trending data (e.g., '24h', '7d'). Defaults to service-specific.
-   * @returns A Promise resolving to an array of TokenData.
-   */
-  abstract getTrendingTokens(
-    chain?: string,
-    limit?: number,
-    timePeriod?: string
-  ): Promise<TokenData[]>;
-
-  /**
-   * Searches for tokens based on a query string.
-   * @param query The search query (e.g., symbol, name, address).
-   * @param chain Optional: Filter by a specific blockchain.
-   * @param limit Optional: Number of results to return.
-   * @returns A Promise resolving to an array of TokenData.
-   */
-  abstract searchTokens(query: string, chain?: string, limit?: number): Promise<TokenData[]>;
-
-  /**
-   * Fetches data for multiple tokens by their addresses on a specific chain.
-   * @param addresses Array of token contract addresses.
-   * @param chain The blockchain the tokens reside on.
-   * @returns A Promise resolving to an array of TokenData. May not include all requested if some are not found.
-   */
-  abstract getTokensByAddresses(addresses: string[], chain: string): Promise<TokenData[]>;
-
-  // Future potential methods:
-  // getHistoricalPriceData(address: string, chain: string, timeFrame: string): Promise<any[]>;
-  // getTokenMarketChart(address: string, chain: string, days: number): Promise<any[]>;
-}