Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 4.59 KB

README.md

File metadata and controls

89 lines (68 loc) · 4.59 KB
Raw

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 the Pocket Network Protocol you can visit pokt.network.

Getting Started

Example 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
  help        help about any command
  nodes       node management
  query       query the blockchain
  reset       reset pocket-core
  start       starts pocket-core daemon
  util        utilities

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>
      --pocketRPCPort string      the port for pocket rpc (default "8081")
      --seeds string              a comma separated list of PeerURLs: <ID>@<IP>:<PORT>
      --tmPeersPort string        the port for tendermint p2p (default "26656")
      --tmRPCPort string          the port for tendermint rpc (default "26657")
  -t, --toggle                    help message for toggle

Installation

Clone the repository and run go build pocket-core/app/cmd/pocket_core/main.go

Documentation

Visit our developer portal for tutorials and technical documentation for the Pocket Network.

Running the tests

To run the Pocket Core unit tests, use the go testing tools and the go test ./... command within the tests directory

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