⚠️ ❗ Update, November 2023: This repo is not under active development. Please head over to poktroll for the latest ongoing implementation of Shannon (next version of the protocol) or pocket-core for the implementation of Morse (the current version of the protocol). ❗ ⚠️

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.*

• Implementation
• Overview
• Getting Started
  • Guides
  • Architectures
  • Changelogs
  • Project Management Resources
• Support & Contact
  • GPokT
• License

Implementation

Official Golang implementation of the Pocket Network v1 Protocol.

Overview

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
• End-to-end testing Guide
• Learning Guide
• Contribution Guide
• Release Guide
• Dependencies Guide
• Telemetry Guide

Architectures

• Shared Architecture
• Utility Architecture
• Consensus Architecture
• Persistence Architecture
• P2P Architecture
• APP Architecture
• RPC Architecture
• Node binary Architecture

Changelogs

• APP Changelog
• Consensus Changelog
• E2E Changelog
• Node binary Changelog
• P2P Changelog
• Persistence Changelog
• RPC Changelog
• Shared Changelog
• Telemetry Changelog
• Utility Changelog

Project Management Resources

• V1 Roadmap
• V1 Project Board

Support & Contact

GPokT

You can also use our chatbot, GPokT, to ask questions about Pocket Network. As of updating this documentation, please note that it may require you to provide your own LLM API token. If the deployed version of GPokT is down, you can deploy your own version by following the instructions here.

License

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