Pocket Core
Official golang implementation of the Pocket Network Protocol.
Overview
The Pocket Core application will allow anyone to spin up a Pocket Network full node, with options to enable/disable functionality and modules according to each deployment. For more information on Pocket Network, visit pokt.network.
Installation
Clone the repository, cd
into it and run go build app/cmd/pocket_core/main.go
.
Usage
To run the Pocket Core binary you can use the following flags alongside the main
executable:
Usage:
pocket [command]
Available Commands:
accounts account management
apps application management
completion Generate the autocompletion script for the specified shell
gov governance management
help Help about any command
nodes node management
query query the blockchain
reset Reset pocket-core
start starts pocket-core daemon
stop Stop pocket-core
util utility functions
version Get current version
Flags:
--datadir string data directory (default is $HOME/.pocket/
-h, --help help for pocket
--node string takes a remote endpoint in the form <protocol>://<host>:<port>
--persistent_peers string a comma separated list of PeerURLs: '<ID>@<IP>:<PORT>,<ID2>@<IP2>:<PORT>...<IDn>@<IPn>:<PORT>'
--remoteCLIURL string takes a remote endpoint in the form of <protocol>://<host> (uses RPC Port)
--seeds string a comma separated list of PeerURLs: '<ID>@<IP>:<PORT>,<ID2>@<IP2>:<PORT>...<IDn>@<IPn>:<PORT>'
Use "pocket [command] --help" for more information about a command.
For more detailed command information, see the usage section.
Documentation
Visit our user documentation for tutorials and technical information on the Pocket Network.
Database Snapshots
Snapshots are provided by Liquify LTD details on how to access the snapshots can be found in snapshot.md
Accessing TestNet
TestNet information can be found at testnet.md
Running the tests
To run the Pocket Core unit tests, go test -short -v -p 1 ./...
Contributing
Please read CONTRIBUTING.md for details on contributions and the process of submitting pull requests.
Support & Contact
License
This project is licensed under the MIT License; see the LICENSE.md file for details