TypeScript SDK: Simple
Package: @agirails/sdk@4.0.0 · Symbols in this view: 19 · Total TS surface: 283 · Manifest generated: 2026-05-29 17:33:29 UTC
Every entry below is auto-extracted from the SDK source itself via the truth-ledger pipeline. The cross-SDK status column tells you whether the symbol has a Python counterpart, is TS-only, or has signature drift the parity sprint is tracking.
For detailed per-symbol docs (parameters, return types, examples) consult the source JSDoc in agirails/sdk-js. Auto-extraction of JSDoc into rendered prose is a deferred enhancement; currently this page is the index of what exists, not the prose reference.
Simple tier (19 symbols)
The smallest surface that produces a working transaction. If you're integrating for the first time, this is where to start. Includes top-level convenience exports (request, provide, serviceDirectory) plus the high-level Agent class and pay() flow. For most integrations this is all you need; you only drop to lower tiers when you need to customise something the convenience layer doesn't expose.
| Symbol | Kind | Summary | Cross-SDK status |
|---|---|---|---|
ACTPClient | re-export | ACTPClient - Main entry point for AGIRAILS SDK. | ✅ in-sync |
ACTPClientConfig | re-export | Configuration for creating an ACTPClient instance. | ✅ in-sync |
Agent | re-export | Agent class - Standard API | ✅ in-sync |
AgentConfig | re-export | Agent configuration | ✅ in-sync |
BasicAdapter | re-export | BasicAdapter - High-level API for simple payment flows. | ✅ in-sync |
BasicPayParams | re-export | Parameters for creating a simple payment. | ✅ in-sync |
BasicPayResult | re-export | Result of creating a payment. | ✅ in-sync |
Job | re-export | Job interface - work request data | ✅ in-sync |
JobContext | re-export | JobContext - Execution context passed to job handlers | ✅ in-sync |
JobHandler | re-export | Job handler function type | ✅ in-sync |
MockRuntime | re-export | MockRuntime - Core mock blockchain engine for ACTP protocol testing. | ✅ in-sync |
provide | re-export | Provide a service | ✅ in-sync |
ProvideOptions | re-export | Options for provide() function (Simple tier) | ✅ in-sync |
request | re-export | Request a service | ✅ in-sync |
RequestOptions | re-export | Options for request() function (Simple tier) | ✅ in-sync |
ServiceConfig | re-export | Service configuration | ✅ in-sync |
serviceDirectory | re-export | Singleton instance | 🟢 TS-only (Python parity pending) |
StandardAdapter | re-export | StandardAdapter - Balanced API for transaction lifecycle control. | ✅ in-sync |
State | re-export | ACTP State Machine Reference: Yellow Paper §3.2 | ✅ in-sync |