README
¶
Parallelcoin Pod
Fully integrated all-in-one cli client, full node, wallet server, miner and GUI wallet for Parallelcoin
Binaries for legacy now available for linux amd64
Get them from here: https://git.parallelcoin.io/dev/parallelcoin-binaries
Pod is a multi-application with multiple submodules for different functions. It is self-configuring and configurations can be changed from the commandline as well as editing the json files directly, so the binary itself is the complete distribution for the suite.
It consists of 6 main modules:
- pod/ctl - command line interface to send queries to a node or wallet and prints the results to the stdout
- pod/node - full node for Parallelcoin network, including optional indexes for address and transaction search, low latency miner UDP broadcast based controller
- pod/wallet - wallet server that runs separately from the full node but depends on a full node RPC for much of its functionality. Currently does not have a full accounts implementation (TODO: fixme!)
- pod/shell - combined full node and wallet server of 2. and 3. running concurrently
- pod/gui - webview based desktop wallet GUI
- pod/kopach - standalone miner with LAN UDP broadcast work delivery system
Building
You can just go install in the repository root and pod will be placed in your GOBIN directory.
Installation
TODO: Initial release will include Linux, Mac and Windows binaries including the GUI, binaries for all platform targets of Go 1.12.9+ without the GUI and standalone kopach miner also for all targets of Go v1.12.9+.
Developer Notes
Goland's inbuilt terminal is a pain but Tilix requires custom hyperlinks to be defined to click and have the IDE open the source at the given location. The regexp that I use given my system base path is (exactly this with all newlines removed for dconf with using tilix at the dconf path /com/gexperts/Tilix/custom-hyperlinks)
[
'(\\./)([^:\\0\\s]+)(:[0-9]+),
goland /home/loki/src/github.com/p9c/node9/$1$2,false',
'(/)([^:\\0\\s]+)(:[0-9]+),
goland $1$2,false'
]
(the text fields in tilix's editor are very weird so it will be easier to just paste this in and gnome should remove the newlines automatically)
which opens absolute paths that are in the repository root given complete or as a relative path with no prefix /.
Better regex would be nice, but this works ok for now.
Documentation
¶
Overview ¶
Package main is the root of the Parallelcoin Pod software suite
It slices, it dices
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app is a multi-function universal binary that does all the things.
|
Package app is a multi-function universal binary that does all the things. |
|
node
Package node is a full-node Parallelcoin implementation written in Go.
|
Package node is a full-node Parallelcoin implementation written in Go. |
|
node/integration/rpctest
Package rpctest provides a pod-specific RPC testing harness crafting and executing integration tests by driving a `pod` instance via the `RPC` interface.
|
Package rpctest provides a pod-specific RPC testing harness crafting and executing integration tests by driving a `pod` instance via the `RPC` interface. |
|
node/mempool
Package mempool provides a policy-enforced pool of unmined bitcoin transactions.
|
Package mempool provides a policy-enforced pool of unmined bitcoin transactions. |
|
pkg
|
|
|
broadcast
Package broadcast is a simple udp broadcast
|
Package broadcast is a simple udp broadcast |
|
chain
Package blockchain implements bitcoin block handling and chain selection rules.
|
Package blockchain implements bitcoin block handling and chain selection rules. |
|
chain/config
Package chaincfg defines chain configuration parameters.
|
Package chaincfg defines chain configuration parameters. |
|
chain/fork
Package fork handles tracking the hard fork status and is used to determine which consensus rules apply on a block
|
Package fork handles tracking the hard fork status and is used to determine which consensus rules apply on a block |
|
chain/fullblocktests
Package fullblocktests provides a set of block consensus validation tests.
|
Package fullblocktests provides a set of block consensus validation tests. |
|
chain/hash
Package chainhash provides abstracted hash functionality.
|
Package chainhash provides abstracted hash functionality. |
|
chain/index
Package indexers implements optional block chain indexes.
|
Package indexers implements optional block chain indexes. |
|
chain/sync
Package netsync implements a concurrency safe block syncing protocol.
|
Package netsync implements a concurrency safe block syncing protocol. |
|
chain/tx
Package wallettx provides ...
|
Package wallettx provides ... |
|
chain/tx/author
Package txauthor provides transaction creation code for wallets.
|
Package txauthor provides transaction creation code for wallets. |
|
chain/tx/mgr
Package wtxmgr provides an implementation of a transaction database handling spend tracking for a bitcoin wallet.
|
Package wtxmgr provides an implementation of a transaction database handling spend tracking for a bitcoin wallet. |
|
chain/tx/rules
Package txrules provides transaction rules that should be followed by transaction authors for wide mempool acceptance and quick mining.
|
Package txrules provides transaction rules that should be followed by transaction authors for wide mempool acceptance and quick mining. |
|
chain/tx/script
Package txscript implements the bitcoin transaction script language.
|
Package txscript implements the bitcoin transaction script language. |
|
chain/tx/sort
Package txsort provides the transaction sorting according to BIP 69.
|
Package txsort provides the transaction sorting according to BIP 69. |
|
chain/wire
Package wire implements the bitcoin wire protocol.
|
Package wire implements the bitcoin wire protocol. |
|
db
Package database provides a block and metadata storage database.
|
Package database provides a block and metadata storage database. |
|
db/ffldb
Package ffldb implements a driver for the database package that uses leveldb or the backing metadata and flat files for block storage.
|
Package ffldb implements a driver for the database package that uses leveldb or the backing metadata and flat files for block storage. |
|
fec
Package fec implements Reed Solomon 9/3 forward error correction,
|
Package fec implements Reed Solomon 9/3 forward error correction, |
|
peer
Package peer provides a common base for creating and managing Bitcoin network peers.
|
Package peer provides a common base for creating and managing Bitcoin network peers. |
|
peer/addrmgr
Package addrmgr implements concurrency safe Bitcoin address manager.
|
Package addrmgr implements concurrency safe Bitcoin address manager. |
|
peer/connmgr
Package connmgr implements a generic Bitcoin network connection manager.
|
Package connmgr implements a generic Bitcoin network connection manager. |
|
rpc/btcjson
Package json provides primitives for working with the bitcoin JSON-RPC API.
|
Package json provides primitives for working with the bitcoin JSON-RPC API. |
|
rpc/client
Package rpcclient implements a websocket-enabled Bitcoin JSON-RPC client.
|
Package rpcclient implements a websocket-enabled Bitcoin JSON-RPC client. |
|
rpc/legacy
AUTOGENERATED by internal/rpchelp/genrpcserverhelp.go; do not edit.
|
AUTOGENERATED by internal/rpchelp/genrpcserverhelp.go; do not edit. |
|
rpc/server
Package rpcserver implements the RPC API and is used by the main package to start gRPC services.
|
Package rpcserver implements the RPC API and is used by the main package to start gRPC services. |
|
scratch/kcpx
Package kcpx is some tidy wrappers around rpcx/kcp RPC communication
|
Package kcpx is some tidy wrappers around rpcx/kcp RPC communication |
|
util
Package util provides bitcoin-specific convenience functions and types.
|
Package util provides bitcoin-specific convenience functions and types. |
|
util/base58
Package base58 provides an API for working with modified base58 and Base58Check encodings.
|
Package base58 provides an API for working with modified base58 and Base58Check encodings. |
|
util/bech32
Package bech32 provides a Go implementation of the bech32 format specified in BIP 173.
|
Package bech32 provides a Go implementation of the bech32 format specified in BIP 173. |
|
util/elliptic
Package ec implements support for the elliptic curves needed for bitcoin.
|
Package ec implements support for the elliptic curves needed for bitcoin. |
|
util/gcs
Package gcs provides an API for building and using a Golomb-coded set filter.
|
Package gcs provides an API for building and using a Golomb-coded set filter. |
|
util/graf
Package graph turns hexadecimal strings into visual representation of the magnitude of digits
|
Package graph turns hexadecimal strings into visual representation of the magnitude of digits |
|
util/hdkeychain
Package hdkeychain provides an API for bitcoin hierarchical deterministic extended keys (BIP0032).
|
Package hdkeychain provides an API for bitcoin hierarchical deterministic extended keys (BIP0032). |
|
util/helpers
Package helpers provides convenience functions to simplify wallet code.
|
Package helpers provides convenience functions to simplify wallet code. |
|
util/treap
Package treap implements a treap data structure that is used to hold ordered key/value pairs using a combination of binary search tree and heap semantics.
|
Package treap implements a treap data structure that is used to hold ordered key/value pairs using a combination of binary search tree and heap semantics. |
Click to show internal directories.
Click to hide internal directories.