README
¶
sidebar_position: 1 title: Poktroll id: home-doc slug: /
poktroll
poktroll is built using the Cosmos SDK and CometBFT, created with Ignite CLI for the Shannon upgrade of the Pocket Network blockchain.
- Learn about Pocket Network
- Developer Documentation
- Roadmap
- Quickstart
- Godoc
- Have questions? Ask An PNYC
- License
Learn about Pocket Network
User friendly documentation of the Shannon upgrade is still a WIP, but there are a handful of (potentially outdated) resources you can reference in the meantime to build a better understanding of Pocket Network:
- Pocket Network official documentation
- [Live] Pocket Network Morse; aka v0
- [Outdated] Pocket Network Protocol
- [Deprecated]Pocket Network V1
Developer Documentation
The developer documentation is available at dev.poktroll.com.
Roadmap
You can view the Shannon Roadmap on Github
Quickstart
The best way to get involved is by following the quickstart instructions.
Godoc
The Godoc for the source code in this can be found at pkg.go.dev/github.com/pokt-network/poktroll.
Have questions? Ask An PNYC
You can use PNYX, an AI-powered search engine that has been trained and indexed on the Pocket Network documentation, community calls, forums and much more!
License
This project is licensed under the MIT License; see the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
poktroll/application
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/application/module
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/gateway
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/gateway/module
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/proof
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/proof/module
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/service
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/service/module
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/session
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/session/module
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/shared
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/shared/module
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/supplier
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/supplier/module
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/tokenomics
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
poktroll/tokenomics/module
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
volatile
Package volatile is intended to host go module members which are need to be re-organized or removed in future work.
|
Package volatile is intended to host go module members which are need to be re-organized or removed in future work. |
|
cmd
|
|
|
load-testing
|
|
|
pkg
|
|
|
client
Package client defines interfaces and types that facilitate interactions with blockchain functionalities, both transactional and observational.
|
Package client defines interfaces and types that facilitate interactions with blockchain functionalities, both transactional and observational. |
|
client/block
Package block contains a light wrapper of the EventsReplayClient[Block] generic which listens for committed block events on chain and emits them through a ReplayObservable.
|
Package block contains a light wrapper of the EventsReplayClient[Block] generic which listens for committed block events on chain and emits them through a ReplayObservable. |
|
client/delegation
Package delegation contains a light wrapper of the EventsReplayClient[Redelegation] generic which listens for redelegation events on chain and emits them through a ReplayObservable.
|
Package delegation contains a light wrapper of the EventsReplayClient[Redelegation] generic which listens for redelegation events on chain and emits them through a ReplayObservable. |
|
client/events
Package events provides a generic client for subscribing to on-chain events via an EventsQueryClient and transforming the received events into the type defined by the EventsReplayClient's generic type parameter.
|
Package events provides a generic client for subscribing to on-chain events via an EventsQueryClient and transforming the received events into the type defined by the EventsReplayClient's generic type parameter. |
|
client/events/websocket
Package websocket provides a websocket client used to connect to a cosmos-sdk based chain node and subscribe to events via the EventsQueryClient.
|
Package websocket provides a websocket client used to connect to a cosmos-sdk based chain node and subscribe to events via the EventsQueryClient. |
|
client/query
Package query provides interfaces used to query the state of the blockchain.
|
Package query provides interfaces used to query the state of the blockchain. |
|
crypto
Package crypto provides the cryptographic primitives used by the Pocket Network.
|
Package crypto provides the cryptographic primitives used by the Pocket Network. |
|
crypto/rings
Package rings provides the RingCache interface that is used to build rings for applications by either the application itself or a gateway.
|
Package rings provides the RingCache interface that is used to build rings for applications by either the application itself or a gateway. |
|
deps/config
Package config provides a method by which dependencies can be injected into dependency chains, via the use of SupplierFn functions.
|
Package config provides a method by which dependencies can be injected into dependency chains, via the use of SupplierFn functions. |
|
Package telemetry provides a set of functions for incrementing counters which track various events across the codebase.
|
Package telemetry provides a set of functions for incrementing counters which track various events across the codebase. |
|
tests
|
|
|
testutil
|
|
|
integration
The integration package contains the preparation of a full application to be used for module integration tests.
|
The integration package contains the preparation of a full application to be used for module integration tests. |
|
nullify
Package nullify provides methods to init nil values structs for test assertion.
|
Package nullify provides methods to init nil values structs for test assertion. |
|
testclient/testblock
Package testblock provides helper functions for constructing real (e.g.
|
Package testblock provides helper functions for constructing real (e.g. |
|
testclient/testdelegation
Package testdelegation provides helper functions for constructing real (e.g.
|
Package testdelegation provides helper functions for constructing real (e.g. |
|
testclient/testeventsquery
Package testeventsquery provides helper functions for constructing real (e.g.
|
Package testeventsquery provides helper functions for constructing real (e.g. |
|
testclient/testqueryclients
Package testqueryclients provides helper functions for contstructing mock AccountQueryClient objects parameterized call arguments, return value(s), and/or expectations thereof.
|
Package testqueryclients provides helper functions for contstructing mock AccountQueryClient objects parameterized call arguments, return value(s), and/or expectations thereof. |
|
testcrypto/rings
Package testrings provides helper functions for constructing real (e.g.
|
Package testrings provides helper functions for constructing real (e.g. |
|
tools
|
|
|
iavl-tree-diff
Module
|
|
|
x
|
|
|
application/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
gateway/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
proof/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
service/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
session/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
shared/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
supplier/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
tokenomics/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
Click to show internal directories.
Click to hide internal directories.