技术文档

涵盖规范、架构、安全分析和实现细节的完整文档

📋

VagusSpec.md

完整的Vagus规范文档,定义了所有核心概念、接口、协议和数据结构。是理解Vagus系统的核心参考文档。

覆盖内容:
  • 核心抽象定义(Afferent、VTI、三态等)
  • 统一事件规范(CapabilityIssued、AEPPosted等)
  • 接口协议与数据格式
  • 安全机制与约束条件
状态: 核心规范已完成。实现正在进行中。
🏗️

Architecture.md

系统架构文档,详细描述Vagus的整体设计、分层架构、组件交互流程和技术决策。

架构内容:
  • 分层架构设计(合约、网关、Oracle、规划器)
  • 数据流与控制流图
  • 跨链与扩展性考虑
  • 性能与安全权衡分析
状态: 高层架构已定义。详细设计正在进行中。
🛡️

ThreatModel.md

威胁模型分析,系统性地识别潜在安全风险、攻击向量以及相应的缓解策略。确保系统的健壮性。

安全分析:
  • STRIDE威胁分类
  • 攻击树分析
  • 缓解措施与安全控制
  • 剩余风险评估
状态: 初步威胁建模已完成。正在进行持续安全审查。
🔧

API 参考

各组件的API文档,包括智能合约接口、Rust库函数、Python SDK方法和REST端点定义。

API类型:
  • Solidity合约ABI
  • Rust库crate文档
  • Python SDK方法
  • RESTful API端点
状态: 合约API已记录。其他API正在开发中。
📊

集成指南

详细的集成教程,帮助开发者将Vagus组件集成到现有系统中。包含代码示例和最佳实践。

指南内容:
  • 智能合约集成
  • 设备网关部署
  • 安全策略配置
  • 监控与调试
状态: 基本集成示例可用。综合指南计划中。
📖

开发者手册

面向开发者的实用指南,涵盖从环境搭建到生产部署的完整开发流程。

手册章节:
  • 开发环境配置
  • 组件开发指南
  • 测试策略
  • 贡献规范
状态: 基本设置指南可用。综合文档正在进行中。

开发路线图

当前开发进度和计划里程碑

阶段 描述 状态 关键交付
第一阶段:基础建设 项目脚手架、CI/CD、基础文档 已完成 仓库设置、基础CI、初始文档
第二阶段:核心合约 Solidity核心合约开发与测试 进行中 ANSStateManager、CapabilityIssuer、VagalBrake
第三阶段:设备网关 Rust网关实现与设备集成 计划中 事件监听、AEP发布、VTI计算
第四阶段:预言机网络 去中心化预言机服务开发 计划中 VTI计算、状态更新、多源融合
第五阶段:架构与规划器 Python规划器与架构系统 计划中 YAML架构、代码生成、EIP-712签名
第六阶段:高级功能 RateLimiter、治理等高级功能 待办事项 高级安全控制、治理机制