Home

Pocket

The official implementation of the V1 Pocket Network Protocol Specification.

*Please note that V1 protocol is currently under development and see pocket-core for the version that is currently live on mainnet.*

Getting Started

---

Some relevant links are listed below. Refer to the complete ongoing documentation at the Pocket GitHub Wiki.

If you'd like to contribute to the Pocket V1 Protocol, start by:

1. Get up and running by reading the Development Guide
2. Find a task by reading the Contribution Guide
3. Dive into any of the other guides or modules depending on where your interests lie

Guides

• Development Guide
• Learning Guide
• Contribution Guide
• Release Guide
• Dependencies Guide
• Telemetry Guide

Architectures

• Shared Architecture
• Utility Architecture
• Coming Soon: Consensus Architecture // TODO(olshansky): needs a README file with proper code structure
• Persistence Architecture
• P2P Architecture
• CLI Architecture
• RPC Architecture
• Node binary Architecture

Changelogs

• Coming Soon: Shared Changelog

• Utility Changelog

• Consensus Changelog

• Persistence Changelog

• P2P Changelog

• CLI Changelog

• RPC Changelog

• Node binary Changelog

• Coming Soon: Telemetry Changelog

Support & Contact

---

License

This project is licensed under the MIT License; see the LICENSE file for details.