fuwei1217/specs

Technical specifications for the DSP protocol stack

DSP specs

This repository contains the specs for the DSP Protocol and associated subsystems.

Spec badges and lifecycle

We use the following label system to identify the state of each spec:

• - A work-in-progress, possibly to describe an idea before actually committing to a full draft of the spec.
• - A draft that is ready to review. It should be implementable.
• - A spec that has been adopted (implemented) and can be used as a reference point to learn how the system works.
• - We consider this spec to close to final, it might be improved but the system it specifies should not change fundamentally.
• - This spec will not change.
• - This spec is no longer in use.

The DSP protocol stack is under development and all specs are still draft

Index

The specs contained in this repository are:

• DSP Protocol:
  • Protocol Architecture Overview - the top-level spec and the stack
• API:
  • REST_API - client restful api
  • REST_API_ERROR - error code used in rest
• Network proxy:
  • Proxy - proxy for exchange block data
• Networking layer:
  • P2P - underlying communication module for the all services
• Naming systems:
  • SCAN - Simple Content Addressing Node
  • DNS - Distributed Name Service
• FS:
  • FS - underlying module for file storage

Contributing

Thank you for considering contributing to DSP. We welcome any individuals and organizations on the Internet to participate in this open source project.