@elizaos/core 1.5.3-beta.3 → 1.5.5-alpha.10

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/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[]>;
-}

package/src/types/transcription.ts

@@ -1,133 +0,0 @@
-import { Service, ServiceType } from './service';
-
-export interface TranscriptionOptions {
-  language?: string;
-  model?: string;
-  temperature?: number;
-  prompt?: string;
-  response_format?: 'json' | 'text' | 'srt' | 'vtt' | 'verbose_json';
-  timestamp_granularities?: ('word' | 'segment')[];
-  word_timestamps?: boolean;
-  segment_timestamps?: boolean;
-}
-
-export interface TranscriptionResult {
-  text: string;
-  language?: string;
-  duration?: number;
-  segments?: TranscriptionSegment[];
-  words?: TranscriptionWord[];
-  confidence?: number;
-}
-
-export interface TranscriptionSegment {
-  id: number;
-  text: string;
-  start: number;
-  end: number;
-  confidence?: number;
-  tokens?: number[];
-  temperature?: number;
-  avg_logprob?: number;
-  compression_ratio?: number;
-  no_speech_prob?: number;
-}
-
-export interface TranscriptionWord {
-  word: string;
-  start: number;
-  end: number;
-  confidence?: number;
-}
-
-export interface SpeechToTextOptions {
-  language?: string;
-  model?: string;
-  continuous?: boolean;
-  interimResults?: boolean;
-  maxAlternatives?: number;
-}
-
-export interface TextToSpeechOptions {
-  voice?: string;
-  model?: string;
-  speed?: number;
-  format?: 'mp3' | 'wav' | 'flac' | 'aac';
-  response_format?: 'mp3' | 'opus' | 'aac' | 'flac';
-}
-
-/**
- * Interface for audio transcription and speech services
- */
-export abstract class ITranscriptionService extends Service {
-  static override readonly serviceType = ServiceType.TRANSCRIPTION;
-
-  public readonly capabilityDescription = 'Audio transcription and speech processing capabilities';
-
-  /**
-   * Transcribe audio file to text
-   * @param audioPath - Path to audio file or audio buffer
-   * @param options - Transcription options
-   * @returns Promise resolving to transcription result
-   */
-  abstract transcribeAudio(
-    audioPath: string | Buffer,
-    options?: TranscriptionOptions
-  ): Promise<TranscriptionResult>;
-
-  /**
-   * Transcribe video file to text (extracts audio first)
-   * @param videoPath - Path to video file or video buffer
-   * @param options - Transcription options
-   * @returns Promise resolving to transcription result
-   */
-  abstract transcribeVideo(
-    videoPath: string | Buffer,
-    options?: TranscriptionOptions
-  ): Promise<TranscriptionResult>;
-
-  /**
-   * Real-time speech to text from audio stream
-   * @param audioStream - Audio stream or buffer
-   * @param options - Speech to text options
-   * @returns Promise resolving to transcription result
-   */
-  abstract speechToText(
-    audioStream: NodeJS.ReadableStream | Buffer,
-    options?: SpeechToTextOptions
-  ): Promise<TranscriptionResult>;
-
-  /**
-   * Convert text to speech
-   * @param text - Text to convert to speech
-   * @param options - Text to speech options
-   * @returns Promise resolving to audio buffer
-   */
-  abstract textToSpeech(text: string, options?: TextToSpeechOptions): Promise<Buffer>;
-
-  /**
-   * Get supported languages for transcription
-   * @returns Promise resolving to array of supported language codes
-   */
-  abstract getSupportedLanguages(): Promise<string[]>;
-
-  /**
-   * Get available voices for text to speech
-   * @returns Promise resolving to array of available voices
-   */
-  abstract getAvailableVoices(): Promise<
-    Array<{
-      id: string;
-      name: string;
-      language: string;
-      gender?: 'male' | 'female' | 'neutral';
-    }>
-  >;
-
-  /**
-   * Detect language of audio file
-   * @param audioPath - Path to audio file or audio buffer
-   * @returns Promise resolving to detected language code
-   */
-  abstract detectLanguage(audioPath: string | Buffer): Promise<string>;
-}

package/src/types/video.ts

@@ -1,108 +0,0 @@
-import { Service, ServiceType } from './service';
-
-export interface VideoInfo {
-  title?: string;
-  duration?: number;
-  url: string;
-  thumbnail?: string;
-  description?: string;
-  uploader?: string;
-  viewCount?: number;
-  uploadDate?: Date;
-  formats?: VideoFormat[];
-}
-
-export interface VideoFormat {
-  formatId: string;
-  url: string;
-  extension: string;
-  quality: string;
-  fileSize?: number;
-  videoCodec?: string;
-  audioCodec?: string;
-  resolution?: string;
-  fps?: number;
-  bitrate?: number;
-}
-
-export interface VideoDownloadOptions {
-  format?: string;
-  quality?: 'best' | 'worst' | 'bestvideo' | 'bestaudio' | string;
-  outputPath?: string;
-  audioOnly?: boolean;
-  videoOnly?: boolean;
-  subtitles?: boolean;
-  embedSubs?: boolean;
-  writeInfoJson?: boolean;
-}
-
-export interface VideoProcessingOptions {
-  startTime?: number;
-  endTime?: number;
-  outputFormat?: string;
-  resolution?: string;
-  bitrate?: string;
-  framerate?: number;
-  audioCodec?: string;
-  videoCodec?: string;
-}
-
-/**
- * Interface for video processing and download services
- */
-export abstract class IVideoService extends Service {
-  static override readonly serviceType = ServiceType.VIDEO;
-
-  public readonly capabilityDescription = 'Video download, processing, and conversion capabilities';
-
-  /**
-   * Get video information without downloading
-   * @param url - Video URL
-   * @returns Promise resolving to video information
-   */
-  abstract getVideoInfo(url: string): Promise<VideoInfo>;
-
-  /**
-   * Download a video from URL
-   * @param url - Video URL
-   * @param options - Download options
-   * @returns Promise resolving to downloaded file path
-   */
-  abstract downloadVideo(url: string, options?: VideoDownloadOptions): Promise<string>;
-
-  /**
-   * Extract audio from video
-   * @param videoPath - Path to video file or video URL
-   * @param outputPath - Optional output path for audio file
-   * @returns Promise resolving to audio file path
-   */
-  abstract extractAudio(videoPath: string, outputPath?: string): Promise<string>;
-
-  /**
-   * Generate thumbnail from video
-   * @param videoPath - Path to video file or video URL
-   * @param timestamp - Timestamp in seconds to capture thumbnail
-   * @returns Promise resolving to thumbnail image path
-   */
-  abstract getThumbnail(videoPath: string, timestamp?: number): Promise<string>;
-
-  /**
-   * Convert video to different format
-   * @param videoPath - Path to input video file
-   * @param outputPath - Path for output video file
-   * @param options - Processing options
-   * @returns Promise resolving to converted video path
-   */
-  abstract convertVideo(
-    videoPath: string,
-    outputPath: string,
-    options?: VideoProcessingOptions
-  ): Promise<string>;
-
-  /**
-   * Get available formats for a video URL
-   * @param url - Video URL
-   * @returns Promise resolving to available formats
-   */
-  abstract getAvailableFormats(url: string): Promise<VideoFormat[]>;
-}

package/src/types/wallet.ts

@@ -1,56 +0,0 @@
-import { Service, ServiceType } from './service';
-import type { TokenBalance } from './token';
-
-/**
- * Represents a single asset holding within a wallet, including its value.
- * This extends a generic TokenBalance with wallet-specific valuation.
- */
-export interface WalletAsset extends TokenBalance {
-  priceUsd?: number;
-  valueUsd?: number;
-}
-
-/**
- * Represents the entire portfolio of assets in a wallet.
- */
-export interface WalletPortfolio {
-  totalValueUsd: number;
-  assets: WalletAsset[];
-}
-
-/**
- * Abstract interface for a Wallet Service.
- * Plugins that provide wallet functionality (e.g., for Solana, EVM) should implement this service.
- * It provides a standardized way for other plugins to query the state of a wallet.
- */
-export abstract class IWalletService extends Service {
-  static override readonly serviceType = ServiceType.WALLET;
-
-  public readonly capabilityDescription =
-    'Provides standardized access to wallet balances and portfolios.';
-
-  /**
-   * Retrieves the entire portfolio of assets held by the wallet.
-   * @param owner - Optional: The specific wallet address/owner to query if the service manages multiple.
-   * @returns A promise that resolves to the wallet's portfolio.
-   */
-  abstract getPortfolio(owner?: string): Promise<WalletPortfolio>;
-
-  /**
-   * Retrieves the balance of a specific asset in the wallet.
-   * @param assetAddress - The mint address or native identifier of the asset.
-   * @param owner - Optional: The specific wallet address/owner to query.
-   * @returns A promise that resolves to the user-friendly (decimal-adjusted) balance of the asset held.
-   */
-  abstract getBalance(assetAddress: string, owner?: string): Promise<number>;
-
-  /**
-   * Transfers SOL from a specified keypair to a given public key.
-   * This is a low-level function primarily for Solana-based wallet services.
-   * @param from - The Keypair of the sender.
-   * @param to - The PublicKey of the recipient.
-   * @param lamports - The amount in lamports to transfer.
-   * @returns A promise that resolves with the transaction signature.
-   */
-  abstract transferSol(from: any, to: any, lamports: number): Promise<string>;
-}