This is the living technical documentation for the protocol design, implementation, and operation. If you're looking for general documentation related to Pocket Network, please visit docs.pokt.network.
Pocket Network Shannon Technical Docs (aka pocket)
pocket is the source code and core implementation of the Shannon upgrade for Pocket Network.
pocket is built using the Cosmos SDK, CometBFT and Ignite CLI.
What is Pocket Network?
This documentation is not intended to answer this question as of 02/2025
Consider reading this post from 02/2025 by @olshansk to get some understanding of why you need Pocket & Grove.
Table of Contents
Where do I start?
- Guides & Deployment: Deployment cheat sheets and config overviews for node runners, infrastructure operators and CLI users.
- Tools & Explorers: Explorers, wallets, faucets and other resources to interact with the network.
- Core Developers: Guides & walkthroughs for core or external developers looking to contribute to the core protocol or SDK.
- Protocol Design: Learn more about tokenomics design & protocol architecture.
As of 02/2025, this documentation is under construction and does not have a clear user journey. Different parts are intended to serve as references one can link to or jump to/from when needed.
Shannon Roadmap
The Shannon Roadmap, along with all past, active and future work is tracked via this Github project.
PATH for Gateways
Grove is developing PATH for anyone who aims to deploy a Pocket Network gateway. Visit the docs to get started.
The PATH Roadmap, along with all past, active and future work is tracked via this Github project.
GoDoc Documentation
The Godoc for the source code can be found at pkg.go.dev/github.com/pokt-network/pocket.
License
This project is licensed under the MIT License; see the LICENSE file for details.