ferrox 0.1.0

A Rust framework for building AI agents for hyperliquid and solana
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

pub mod null_agent;
pub mod text_agent;

use std::{future::Future, pin::Pin, sync::Arc};

use ferrox_actions::{ActionGroup, AgentState, ConfirmHandler, FunctionAction};
pub use null_agent::NullAgent;

/// Agent trait represents an LLM with state management capabilities
/// The state type S must be Send + Sync + Clone + 'static
pub trait Agent<S: Send + Sync + Clone + 'static = ()>: Clone {
    /// Adds a tool to the agent
    fn add_action(&mut self, action: Arc<FunctionAction<S>>);

    /// Adds all actions from an action group
    fn add_action_group<G: ActionGroup<S>>(&mut self, group: &G) {
        for action in group.actions() {
            self.add_action(action.clone());
        }
    }

    /// Returns the system prompt for the agent
    fn system_prompt(&self) -> &str;

    /// Returns a reference to the agent's state
    fn state(&self) -> AgentState<S>;

    /// Takes in a prompt and returns the stringified response.
    /// This will automatically add the tool calls to the prompt.
    fn process_prompt(
        &self,
        prompt: &str,
        history_id: &str,
        send_state: serde_json::Value,
    ) -> Pin<
        Box<
            dyn Future<
                    Output = Result<
                        (String, Option<(serde_json::Value, ConfirmHandler<S>)>),
                        String,
                    >,
                > + Send
                + Sync,
        >,
    >;
}