@aweto-agent/types
v1.3.1
Published
Shared types for AWEtoAgent framework
Downloads
431
Readme
@aweto-agent/types
Shared TypeScript type definitions for the awe-agents framework.
Overview
This package provides the core type definitions used across all awe-agents packages. It has zero dependencies on other @AWEtoAgent packages, making it a pure leaf package in the dependency graph.
What's Included
- Core Types:
AgentMeta,AgentContext,Usage - Entrypoint Types:
EntrypointDef,EntrypointHandler,EntrypointStreamHandler - Pricing Types:
EntrypointPrice,PaymentsConfig,SolanaAddress - Streaming Types:
StreamEnvelope,StreamResult, and related stream types - Re-exports:
Networkfromx402/types
Installation
bun add @aweto-agent/typesUsage
import type {
AgentMeta,
EntrypointDef,
PaymentsConfig,
Network,
} from '@aweto-agent/types';
const meta: AgentMeta = {
name: 'my-agent',
version: '1.0.0',
description: 'My agent description',
};
const entrypoint: EntrypointDef = {
key: 'echo',
description: 'Echo back input',
price: '1000',
network: 'base-sepolia',
handler: async (ctx) => {
return {
output: ctx.input,
usage: { total_tokens: 0 },
};
},
};Design Philosophy
This package follows the types-in-core pattern used by mature TypeScript frameworks like TanStack. By centralizing type definitions:
- Zero Circular Dependencies: All other packages import from this package, never the reverse
- Single Source of Truth: Type contracts are defined in one place
- Better IDE Support: Type inference and autocomplete work seamlessly
- Smaller Bundles: Types are erased at compile time, adding no runtime overhead
Dependencies
This package has no dependencies on other @AWEtoAgent packages. It only depends on:
zod(peer dependency for type inference)x402(forNetworktype re-export)
License
MIT
