Skip to content
YieldSeeker Docs

Agent type integration contract

An agent type supplies its strategy, rules and monitor within YieldSeeker’s shared platform contract. AGENT TYPEREQUIRED PARTSStrategy · goal · permitted operationsRule types · memory compilationMonitor · metrics · API

An agent type defines a strategy runtime inside the shared YieldSeeker account, wallet, authorization, and safety model.

Every type should specify:

  • a stable type identifier, goal, success metrics, and supported chains and assets
  • creation and activation fields, plus permitted operations
  • rule types and their parser, where the type supports rules or memory compilation
  • monitoring metrics and status states
  • user controls and exit behavior
  • API errors and retry/idempotency rules
  • strategy-specific risks

When a type supports rules, it registers a parser to validate rule configurations and identify which rule types can be compiled from memories. Without a registered parser, the rule system allows no rules for that type.

Each type-specific Monitor passes its agentType and typed rule class to the shared Monitor base, then implements _build_rule_boundaries(agent, snapshot, rules) to build boundaries from holdings and effective typed rules, and _list_metric_values() to supply metric values keyed by (chainId, subjectKey, metric). The base handles boundary refresh, evaluation, states, and shared queries. Rules without measurable limits may produce no boundaries.

A type does not receive unrestricted wallet access. It operates through the same ownership, authorization, adapter, registry, and emergency controls described in Security and AgentWalletKit integration.

vault is the currently available type. It allocates supported assets across approved DeFi vaults and exposes Vault Agent-specific yield, position, and Autoseek operations.

See Creating an agent via API and Vault Agent API integration.

A future borrowing, basis-trade, or other type should be a sibling integration with its own rule parser, monitor, API guide, user guide, metrics, risk disclosure, and support matrix entry.

Do not make Vault Agent fields, APY metrics, vault addresses, or rebalance semantics mandatory for every type.