pocket-core

module

v0.0.0-...-4955b9a Latest Latest Go to latest Published: May 31, 2021 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gaozhengxin/pocket-core

README ¶

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
  gov         governance management
  help        Help about any command
  nodes       node management
  query       query the blockchain
  reset       Reset pocket-core
  start       starts pocket-core daemon
  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>'
  -t, --toggle                    help message for toggle

Use "pocket [command] --help" for more information about a command.

Installation

Clone the repository, cd into it and run go build 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

Directories ¶

Path	Synopsis
app
cmd/cli
cmd/pocket_core
cmd/rpc
baseapp /* Package baseapp contains data structures that provide basic data storage functionality and act as a bridge between the ABCI interface and the SDK abstractions.	/* Package baseapp contains data structures that provide basic data storage functionality and act as a bridge between the ABCI interface and the SDK abstractions.
codec
legacy Package legacy contains a global amino Cdc which is deprecated but still used in several places within the SDK.	Package legacy contains a global amino Cdc which is deprecated but still used in several places within the SDK.
types Package types defines a custom wrapper for google.protobuf.Any which supports cached values as well as InterfaceRegistry which keeps track of types which can be used with Any for both security and introspection	Package types defines a custom wrapper for google.protobuf.Any which supports cached values as well as InterfaceRegistry which keeps track of types which can be used with Any for both security and introspection
unknownproto unknownproto implements functionality to "type check" protobuf serialized byte sequences against an expected proto.Message to report: a) Unknown fields in the stream -- this is indicative of mismatched services, perhaps a malicious actor b) Mismatched wire types for a field -- this is indicative of mismatched services Its API signature is similar to proto.UnmarshalObject([]byte, proto.Message) in the strict case if err := RejectUnknownFieldsStrict(protoBlob, protoMessage, false); err != nil { // Handle the error.	unknownproto implements functionality to "type check" protobuf serialized byte sequences against an expected proto.Message to report: a) Unknown fields in the stream -- this is indicative of mismatched services, perhaps a malicious actor b) Mismatched wire types for a field -- this is indicative of mismatched services Its API signature is similar to proto.UnmarshalObject([]byte, proto.Message) in the strict case if err := RejectUnknownFieldsStrict(protoBlob, protoMessage, false); err != nil { // Handle the error.
crypto
keys
keys/keyerror
keys/mintkey
store
cachekv
cachemulti
dbadapter
errors
gaskv
iavl
list
prefix
queue
rootmulti
tracekv
transient
types
types
module Package module contains application module patterns and associated "manager" functionality.	Package module contains application module patterns and associated "manager" functionality.
x
apps
apps/exported
apps/keeper
apps/types
auth Package auth nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/pokt-network/pocket-core/x/auth/types	Package auth nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/pokt-network/pocket-core/x/auth/types
auth/exported
auth/keeper
auth/types
auth/util
gov nolint	nolint
gov/keeper
gov/types
nodes
nodes/exported
nodes/keeper
nodes/types
pocketcore
pocketcore/keeper
pocketcore/types

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL