How hyperledger-identus/cloud-agent works
Main Components
• Cloud Agent Core: This serves as the central service providing the REST API endpoints for identity management, DID handling, and credential issuance/verification.
• Communication & DID Protocols: Represent the DIDComm V2 and protocol-specific submodules (for issuing, verifying, presenting credentials, and handling different DID methods such as “did:prism” and “did:peer”). These are implemented across modules (for example in “castor”, “connect”, “pollux”, “prism-node”, “mercury”, etc.).
• External Dependencies:
– Secrets Management: Illustrate the Hashicorp Vault integration (as indicated in configuration options) for secure storage and key management.
– PRISM Node: A distinct component that may be used in certain configurations, with a note about compatibility (the README provides a version compatibility table).
– Event Notification Service: A module responsible for HTTP events and webhook notifications.
• Controller / Business Logic Layer: Although the Cloud Agent itself is a backend service, it is designed to be controlled by an external business logic controller (built in any language) that interacts with the agent via HTTP. Thus include the “controller” as an external consumer.
• Infrastructure & Deployment: Containers, Docker images, and container orchestration as defined by “infrastructure”, “docker-compose” files, Helm charts, etc.
Architectural Patterns and Relationships
• Data Flow: Indicate where events are triggered (e.g., webhook notifications) and flows from inbound HTTP requests to back-end protocol processing modules.
• Middleware Components: If needed, include modules for logging (as suggested by configuration files), authentication (OIDC, API keys, etc.), and message brokers for asynchronous messaging (noting messaging support in “shared/messaging” and event notification modules).
Reference to Underlying Technologies
• Scala / SBT: Represent that the main service is implemented in Scala (noting presence of “build.sbt” and many Scala source folders).
• Containerization: Show Docker, Docker Compose, and orchestration elements as part of the infrastructure layer.
• External Services: Clearly mark integration points for Cardano, Vault, and PRISM Node.
• Optionally, include additional details like version compatibility notes (e.g., between Cloud Agent and PRISM Node) as annotations.
• Error flows or status endpoints (as indicated by health checks in the README).