How extrimian/vcsl works
Project type and purpose
• This is a microservice-based backend system for managing and verifying the status of verifiable credentials (VCSL).
• It comprises two HTTP API services (VCSL API and IPFS API), a relational database (PostgreSQL), an in-memory lock store (Redis), and integration with IPFS and a blockchain/Web3 layer.
File structure
• Top level:
• docker-compose.yml – orchestrates containers for all services and data stores.
• ipfs_api/ – standalone microservice for uploading and resolving on IPFS/IPNS.
• vcsl_api/ – main microservice exposing business endpoints.
• pg_hba.conf – database auth config.
• ipfs_api: a minimal FastAPI or Flask-style app (main.py, dto.py), Dockerfile and startup script.
• vcsl_api: layered structure:
• main.py – entry point and router registration.
• routers/ – HTTP route handlers for bit arrays, web3, health.
• services/ – business logic and integrations: IPFS, Redis locks, caching, Web3, bit array operations.
• persistance/ – Postgres DAO and datastore implementation.
• models/ – data transfer objects and domain types.
• misc/ – dependency injection and scheduling.
• resources/ – smart contract ABI.
• test/ – Postman collection and pytest fixtures.
README for additional insights
• The system uses a bit array where each bit represents credential status.
• Persistence methods: IPFS, SQL DB, blockchain.
• Redis is used strictly for distributed locks.
• Exposed endpoints cover health, bit-array CRUD and operations, plus Web3 issuer and VCSL registration.
Detail and essential elements
• Docker Compose network to show that services share an internal bridge network.
• Critical interactions such as locks and caching.
• Scheduled/background tasks invoking Web3 or IPFS.
• If space permits, illustrate the layer breakdown inside the VCSL API boundary: routers → services → persistence.