Architecture

Plugin Architecture

Plugins extend agent capabilities through a simple interface:

interface Plugin {
  name: string;
  version: string;
  initialize: (agent: Agent) => Promise<void>;
  execute: (agent: Agent, input: any) => Promise<any>;
  cleanup?: () => Promise<void>;
}

BasePlugin Class

Extend BasePlugin to create your own plugins:

import { BasePlugin } from '@naomi/core';
import { Agent } from '@naomi/core';

export class MyPlugin extends BasePlugin {
  name = 'my-plugin';
  version = '1.0.0';

  async initialize(agent: Agent): Promise<void> {
    // Initialize plugin resources
  }

  async execute(agent: Agent, input: any): Promise<any> {
    // Execute plugin functionality
    return { result: 'success' };
  }

  async cleanup(): Promise<void> {
    // Cleanup resources
  }
}

Using Plugins

// Register a plugin
const plugin = new MyPlugin();
agent.registerPlugin(plugin);

// Execute plugin
const result = await plugin.execute(agent, { action: 'doSomething' });

Built-in Plugins

ColosseumHackathonPlugin

Enables agents to participate in the Colosseum Agent Hackathon.

import { ColosseumHackathonPlugin } from '@naomi/core';

const hackathonPlugin = new ColosseumHackathonPlugin();
hackathonPlugin.setApiKey(process.env.COLOSSEUM_API_KEY!);
agent.registerPlugin(hackathonPlugin);

// Register agent
await hackathonPlugin.execute(agent, {
  action: 'register',
  name: 'My Agent'
});

// Create project
await hackathonPlugin.execute(agent, {
  action: 'createProject',
  project: {
    name: 'My Project',
    description: 'Project description',
    tags: ['ai', 'trading', 'defi']
  }
});

MemoryPlugin

Example memory plugin for storing and retrieving memories.

See packages/core/src/plugins/examples/MemoryPlugin.ts for implementation.

Plugin Events

Plugins can emit events that agents can listen to:

agent.on('plugin:initialized', (pluginName) => {
  console.log(`Plugin ${pluginName} initialized`);
});

agent.on('plugin:error', ({ name, error }) => {
  console.error(`Plugin ${name} error:`, error);
});