Docs/System Architecture
Documentation

System Architecture

The Bio-DID-Seq ecosystem integrates multiple components including decentralized identifiers, AI powered processing, knowledge graphs, and secure data management to create a comprehensive platform for research data.

Overview

The system integrates several key components:

  • Bio-DID-Seq Core: The foundation providing decentralized identifiers and GDPR compliant data management
  • BioAgents: AI powered agents for research data processing and knowledge extraction
  • Knowledge Graph: Semantic representation of biological entities and relationships
  • IPFS Storage Layer: Decentralized and content addressed storage
  • UCAN Authorization: Capability based security model
USERSResearcher / UserWeb Interface / APIBIO-DID-SEQ COREDID ManagementIdentity ResolutionUCAN IssuanceAPI GatewayBIOAGENTSKnowledge ExtractionEntity RecognitionAI ProcessingNL InterfaceKNOWLEDGE & STORAGEKnowledge GraphSPARQL · entity relationshipsIPFS Storagecontent-addressed data layerTRUST & PUBLICATIONUCAN Authorizationcapability-based securityDataverseDOI registry · publicationauthenticated requestsAI processingsemantic storageauthorize & publish
System Architecture

Core Component Interactions

Integration Architecture

APPLICATION LAYERUsersubmits researchBio-DID-Seq APIBioAgentsmetadata + entitiesAUTHORIZATION LAYERUCAN Authorizationcapability tokensDelegated Accessshare & controlIDENTITY LAYER · SSIW3C DID ImplementationJWT / VC CreationSolana Programon-chain registrySTORAGE LAYERIPFS Storagecontent-addressedPinning ServicepersistenceINTEGRATIONHarvard Dataverse · ZenodopublicationResearch Institutionsacademic partnersauthorizecreate & link DIDstorepublish
System Integration

Component Responsibilities

ComponentPrimary ResponsibilitySecondary Functions
Bio-DID-Seq CoreDID ManagementMetadata Registry, UCAN Issuance
BioAgentsKnowledge ExtractionEntity Recognition, Relationship Detection
Knowledge GraphSemantic RepresentationSPARQL Queries, Data Discovery
IPFS StorageDecentralized Data StorageContent Addressing, Data Integrity
UCAN ServiceAuthorization & Access ControlCapability Delegation, Permission Management

System Integration Workflows

1. Research Paper Processing Workflow

Upload Research PaperAuthenticate & AuthorizeStore PaperReturn CIDProcess Paper (CID)Retrieve PaperExtract KnowledgeGenerate Knowledge GraphStore Extracted KnowledgeReturn Graph IDReturn Processing ResultsUpdate DID DocumentPublish to DataverseReturn DOIReturn Complete ResultsResearcherBio-DID-Seq APIIPFS StorageBioAgentsKnowledge GraphDataverse
Sequence Diagram

2. Knowledge Query Workflow

Knowledge Query + TokenValidate UCAN TokenAuthorization ResultAuthorizedForward QueryProcess QueryReturn ResultsUnauthorizedAccess DeniedResearcherBio-DID-Seq APIUCAN ServiceKnowledge Graph
Knowledge Query Workflow

3. UCAN Delegation Workflow

Request UCAN for CollaboratorGenerate UCAN TokenReturn TokenReturn UCAN TokenShare TokenRequest Data AccessValidate TokenValidation ResultGrant AccessProvide DataData OwnerBio-DID-SeqUCAN ServiceCollaboratorData Resource
UCAN Delegation

Technical Integration Details

1. API Integration

typescript
// Example API routes showing system integration
const apiRoutes = {
  // Bio-DID-Seq Core Routes
  "/api/did": "DID document management",
  "/api/auth": "Authentication & UCAN issuance",
  
  // BioAgents Integration Routes
  "/api/bioagents/process": "Process research papers",
  "/api/bioagents/query": "Natural language queries",
  
  // Knowledge Graph Routes
  "/api/kg/sparql": "SPARQL query endpoint",
  "/api/kg/search": "Semantic search interface",
  
  // Data Integration Routes
  "/api/dataverse": "Dataverse integration",
  "/api/ipfs": "IPFS storage operations"
};

2. Service Communication

Services communicate using a combination of:

  • REST APIs: For synchronous operations
  • Event Bus: For asynchronous workflows
  • WebSockets: For real time updates
  • gRPC: For high performance internal service communication

Security Integration

1. Authentication Flow

Login RequestVerify DIDDID VerificationGenerate Auth TokenReturn Auth TokenAPI Request + Auth TokenValidate TokenValidation ResultProcess RequestResponseUserAuth ServiceDID ServiceBio-DID-Seq API
Authentication Flow

2. UCAN Authorization

typescript
async function validateCapability(ucanToken, requiredCapability, resourceId) {
  const valid = await ucanService.verify(ucanToken);
  if (!valid) return false;
  
  const hasCapability = await ucanService.hasCapability(
    ucanToken, 
    requiredCapability,
    resourceId
  );
  
  return hasCapability;
}

Deployment Architecture

All components are containerized using Docker with microservices architecture supporting horizontal scaling.

Integration Benefits

  • Data Sovereignty: Researchers maintain control of their data
  • Enhanced Discoverability: Knowledge graphs make data more findable
  • Simplified Collaboration: UCAN delegation enables secure sharing
  • Reduced Integration Burden: Standardized APIs and formats
  • Future Proof Architecture: Extensible and modular design