README
¶
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
All the links you'll need are listed below. If you'd like to contribute to the Pocket V1 Protocol, start by:
- Reading the Contribution Guide
- Get things running by reading the Development Guide
- Dive into any of the other guides or modules depending on where your interests lie
Guides
Architectures
- Shared Architecture
- Coming Soon: Consensus Architecture
- PrePersistence Architecture
- P2P Architecture
- Utility Architecture
Changelogs
- Consensus Changelog
- Utility Changelog
- Coming Soon: P2P Changelog
- Coming Soon: Persistence Changelog
Support & Contact
License
This project is licensed under the MIT License; see the LICENSE.md file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
client
command
|
|
|
pocket
command
|
|
|
leader_election/vrf
NOTE: At the time of implementation, the VRF library is only used with consensus, but may be extracted into shared/crypto when/if it will be needed elsewhere.
|
NOTE: At the time of implementation, the VRF library is only used with consensus, but may be extracted into shared/crypto when/if it will be needed elsewhere. |
Click to show internal directories.
Click to hide internal directories.