Pocket Network Shannon Technical Docs
poktroll is the source code and core implementation of the Shannon upgrade for Pocket Network.
pocketd
is built using the Cosmos SDK, CometBFT and Ignite CLI.
Where do I get started?
Allocate 1-3 hours of time and go through the Operator Cheat Sheets available.
You'll be able to setup Accounts
, Services
, Full Nodes
, Validators
, Suppliers
, Gateways
or Applications
depending on how you want to participate in the network.
Pocket and PATH
The technical docs for Pocket Network Shannon upgrade are accompanied by PATH documentation.
PATH (Path API & Toolkit Harness) is an open source framework to enable access to a permissionless network of API providers of open source services and data sources without sacrificing enterprise-grade SLAs.
An easy way to think about PATH and Pocket Network is:
- Pocket Network is a permissionless network (i.e. directory) of API providers for open source services and data sources
- PATH is a framework to build a Gateway that ensures a high quality of service atop of Pocket Network using Smart QoS
PATH Roadmap
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.
Shannon Roadmap
The Shannon Roadmap, along with all past, active and future work is tracked via this Github project.
Documents Available
- 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.
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.