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.
To run the Pocket Core binary you can use the following flags alongside the pocket-core
executable:
-cfile string
specifies the filepath for chains.json (default "chains.json")
-clientrpc
whether or not to start the rpc server (default true)
-clientrpcport string
specified port to run client rpc (default "8080")
-datadirectory string
setup a custom location for the datadirectory
(default: `%APPDATA%\Pocket` for Windows, `~/.pocket` for Linux, `~/Library/Pocket` for Mac)
-pfile string
specifies the filepath for peers.json (default "peers.json")
-relayrpc
whether or not to start the rpc server (default true)
-relayrpcport string
specified port to run relay rpc (default "8081")
To run the Pocket Core unit tests, use the go testing tools and the go test ./...
command within the tests directory
Please fork, code and submit a Pull Request for the Pocket Core Team to review and merge. We ask that you please follow the guidelines below in order to submit your contributions for review:
Reach out to us on Telegram and start a discussion with the Pocket Core Team regarding your change before you start working. Communication is key for open source projects and asynchronous contributions.For an active research forum, checkout and post on our forum.
- Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
- (Optional) Use Editor Config to help your Text Editor keep the same formatting used throughout the project.
- Code must be documented adhering to the official Go commentary guidelines.
- Pull requests need to be based on and opened against the `staging` branch.
Run go build pokt-network/pocket-core/cmd/pocket_core/main.go