How openwallet-foundation/acapy works
a. The Agent Core: Represent the central “brain” that integrates all functionality such as protocol routing, event dispatching, configuration management, and the plugin system.
c. Wallet and Key Management: Show the wallet component which handles secure storage, key operations, and supports multiple key types as well as the integration with Askar and anoncreds.
f. Admin API / Controller Interface: Indicate that ACA-Py exposes an OpenAPI-documented REST administrative API (including webhook callbacks) that external controllers use to drive business logic.
Relationships and interactions
b. That the Agent Core routes messages to specific protocol handlers (e.g., didexchange or issue credential protocols) and dispatches events to the webhook interface.
d. That the Transport modules connect the ACA-Py internal processing engine with network endpoints (e.g., HTTP inbound transport receiving messages and outbound transport sending messages).
e. Dependency flows for configuration, logging, and the injection system to show cross-cutting concerns.
Use appropriate architectural patterns/design principles
a. Layering: Visually separate the external API layer, core business logic (protocol handlers, core modules), and lower-level infrastructure (transport, resolution, storage).
c. Extensibility: The dynamic plugin loading mechanism should be shown as an adjunct to the core engine – signifying that new functionality is added without tightly coupling to the core code.
d. Multi-tenancy and Scalability: Illustrate that the ACA-Py deployment can be scaled (either as a single container image or within microservice-like containers) and supports multi-tenant architectures with dedicated secure storage components.
e. API Security: Although not a strict component, note that the Admin API has secure (or insecure, in dev) modes using API keys.
c. Annotations (such as notes on security aspects or plugin extensibility) to give context to the component.
d. Validate that all critical ACA-Py capabilities (protocols, wallet, ledger, DID handling, inbound/outbound communications) and deployment elements (Docker, Helm, Kubernetes) are represented.