Request for Comments (RFC) for HOPR protocol
Welcome to the HOPR RFC Repository (hopr-rfc), the central hub for managing, discussing, and finalising Request for Comments (RFCs) related to the HOPR project. Each RFC resides in its own repository within this organisation, promoting modularity and clear documentation.
RFCs define the core HOPR protocol, its interfaces, and related smart contract specifications. This repository serves as an index and guide for navigating all individual RFC repositories.
Each RFC will have its own dedicated repository to ensure modularity, easy management, and independent versioning. This structure allows for storing associated assets such as images, diagrams, and relevant files within each RFC repository.
/hopr-rfc
│
├── rfcs
│ ├── RFC-0001-rfc-process/ # Repository for RFC process documentation
│ │ ├── assets/ # Related assets (e.g., images, diagrams)
│ │ │ └── process-flow.png
│ │ └── 0001-rfc-process.md # RFC document
│ │
│ ├── RFC-0002-core-protocol/ # Repository for core HOPR protocol
│ │ ├── assets/
│ │ │ └── core-protocol-diagram.mmd
│ │ └── 0002-core-protocol.md
│ │
│ ├── RFC-0003-announcement-contract/ # Repository for announcement contract
│ │ ├── assets/
│ │ └── 0003-announcement-contract.md
│ │
│ └── RFC-0004-return-path/ # Repository for return path component
│ ├── assets/
│ └── 0004-return-path.md
├── scripts # Scripts making sure RFCs are well formatted
├── latex # Scripts used to generate LaTeX and PDF version of the RFCs
├── ui # UI for displaying the awesome RFCs
└── templates # MD templates for the RFCs starter document
The process of contributing RFC is detailed in the ./rfcs/RFC-0001-rfc-process/ and the template to start a new one is in the ./templates/rfc-template.md