pfcd

command module
v0.0.0-...-139b6cb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 18, 2021 License: ISC Imports: 70 Imported by: 0

README

pfcd

Build Status ISC License GoDoc Go Report Card

PicFight coin overview

PicFight coin is a Decred-based cryptocurrency. It utilizes a hybrid proof-of-work and proof-of-stake mining system. A unit of the currency is called a picfight coin (PFC).

https://picfight.org

What is pfcd?

pfcd is a full node implementation of PicFight coin written in Go (golang).

It acts as a fully-validating chain daemon. pfcd maintains the entire past transactional ledger of PicFight coin and allows relaying of transactions to other PicFight coin nodes around the world.

What is a full node?

The term 'full node' is short for 'fully-validating node' and refers to software that fully validates all transactions and blocks, as opposed to trusting a 3rd party. In addition to validating transactions and blocks, nearly all full nodes also participate in relaying transactions and blocks to other full nodes around the world, thus forming a peer-to-peer network.

Getting Started

So, you've decided to help the network by running a full node. Great! Running pfcd is simple. All you need to do is install pfcd on a machine that is connected to the internet and launch it.

Also, make sure your firewall is configured to allow inbound connections to port 9108.

Installing and updating

Setup

Building or updating from source requires the following build dependencies:

  • The pfcd executable will be installed to $GOPATH/bin. GOPATH defaults to $HOME/go (or %USERPROFILE%\go on Windows) if unset.
Build from source (all platforms)

Tip: You can always verify your steps against the Travis. Simply consult with the .travis.yml and the run_tests.sh for the details.

Example of obtaining and building from source on Windows:

Checkout:

go get github.com/picfight/pfcd

Build and install:

cd %GOPATH%
cd src/github.com/picfight/pfcd

set GO111MODULE=on
go build ./...
go install . ./cmd/...
Running Tests

To run the tests locally:

cd %GOPATH%
cd src/github.com/picfight/pfcd

set GO111MODULE=on
go build ./...
go clean -testcache
go test ./...

Example run commands

Launch the default node:

pfcd

Launch a mining node (set your wallet address):

pfcd --generate --miningaddr "JsKFRL5ivSH7CnYaTtaBT4M9fZG878g49Fg"

Launch a mining node with custom settings:

pfcd
     --generate
     --miningaddr "JsKFRL5ivSH7CnYaTtaBT4M9fZG878g49Fg"
     --listen=127.0.0.1:30000
     --rpclisten=127.0.0.1:30001
     --datadir=nodeA
     --rpccert=nodeA\rpc.cert
     --rpckey=nodeA\rpc.key     
     --txindex
     --addrindex
     --rpcuser=node.user
     --rpcpass=node.pass

Launch the second node and connect to it the first one for syncing:

pfcd
     --listen=127.0.0.1:30002
     --rpclisten=127.0.0.1:30003
     --addpeer=127.0.0.1:30000
     --datadir=nodeB
     --rpccert=nodeB\rpc.cert
     --rpckey=nodeB\rpc.key
     --txindex
     --addrindex
     --rpcuser=node.user
     --rpcpass=node.pass
     

Enjoy your little blockchain network for a while.

Contact

If you have any further questions you can find us at the integrated github issue tracker.

Documentation

Since pfcd is a fork of Decred, the documentation for pfcd is located in the Decred-docs folder.

License

pfcd is licensed under the copyfree ISC License.

Documentation

Overview

pfcd is a full-node PicFight coin implementation written in Go.

The default options are sane for most users. This means pfcd will work 'out of the box' for most users. However, there are also a wide variety of flags that can be used to control it.

The following section provides a usage overview which enumerates the flags. An interesting point to note is that the long form of all of these options (except -C) can be specified in a configuration file that is automatically parsed when pfcd starts up. By default, the configuration file is located at ~/.pfcd/pfcd.conf on POSIX-style operating systems and %LOCALAPPDATA%\pfcd\pfcd.conf on Windows. The -C (--configfile) flag, as shown below, can be used to override this location.

Usage:

pfcd [OPTIONS]

Application Options:

-V, --version             Display version information and exit
-C, --configfile=         Path to configuration file
-b, --datadir=            Directory to store data
    --logdir=             Directory to log output.
    --nofilelogging=      Disable file logging.
-a, --addpeer=            Add a peer to connect with at startup
    --connect=            Connect only to the specified peers at startup
    --nolisten            Disable listening for incoming connections -- NOTE:
                          Listening is automatically disabled if the --connect
                          or --proxy options are used without also specifying
                          listen interfaces via --listen
    --listen=             Add an interface/port to listen for connections
                          (default all interfaces port: 9108, testnet: 19108)
    --maxsameip=          Max number of connections with the same IP -- 0 to
                          disable (default: 5)
    --maxpeers=           Max number of inbound and outbound peers (125)
    --nobanning           Disable banning of misbehaving peers
    --banduration=        How long to ban misbehaving peers.  Valid time units
                          are {s, m, h}.  Minimum 1 second (24h0m0s)
    --banthreshold=       Maximum allowed ban score before disconnecting and
                          banning misbehaving peers.
    --whitelist=          Add an IP network or IP that will not be banned.
                          (eg. 192.168.1.0/24 or ::1)
-u, --rpcuser=            Username for RPC connections
-P, --rpcpass=            Password for RPC connections
    --rpclimituser=       Username for limited RPC connections
    --rpclimitpass=       Password for limited RPC connections
    --rpclisten=          Add an interface/port to listen for RPC connections
                          (default port: 9109, testnet: 19109)
    --rpccert=            File containing the certificate file
    --rpckey=             File containing the certificate key
    --rpcmaxclients=      Max number of RPC clients for standard connections
                          (10)
    --rpcmaxwebsockets=   Max number of RPC websocket connections (25)
    --norpc               Disable built-in RPC server -- NOTE: The RPC server
                          is disabled by default if no rpcuser/rpcpass or
                          rpclimituser/rpclimitpass is specified
    --notls               Disable TLS for the RPC server -- NOTE: This is only
                          allowed if the RPC server is bound to localhost
    --nodnsseed           Disable DNS seeding for peers
    --externalip=         Add an ip to the list of local addresses we claim to
                          listen on to peers
    --proxy=              Connect via SOCKS5 proxy (eg. 127.0.0.1:9050)
    --proxyuser=          Username for proxy server
    --proxypass=          Password for proxy server
    --onion=              Connect to tor hidden services via SOCKS5 proxy
                          (eg. 127.0.0.1:9050)
    --onionuser=          Username for onion proxy server
    --onionpass=          Password for onion proxy server
    --noonion             Disable connecting to tor hidden services
    --torisolation        Enable Tor stream isolation by randomizing user
                          credentials for each connection.
    --testnet             Use the test network
    --simnet              Use the simulation test network
    --regnet              Use the regression test network
    --nocheckpoints       Disable built-in checkpoints.  Don't do this unless
                          you know what you're doing.
    --dbtype=             Database backend to use for the Block Chain (ffldb)
    --profile=            Enable HTTP profiling on given [addr:]port -- NOTE: port
                          must be between 1024 and 65536
    --cpuprofile=         Write CPU profile to the specified file
    --memprofile=         Write mem profile to the specified file
    --dumpblockchain=     Write blockchain as a gob-encoded map to the
                          specified file
    --miningtimeoffset=   Offset the mining timestamp of a block by this many
                          seconds (positive values are in the past)
-d, --debuglevel=         Logging level for all subsystems {trace, debug,
                          info, warn, error, critical} -- You may also specify
                          <subsystem>=<level>,<subsystem2>=<level>,... to set
                          the log level for individual subsystems -- Use show
                          to list available subsystems (info)
    --upnp                Use UPnP to map our listening port outside of NAT
    --minrelaytxfee=      The minimum transaction fee in PFC/kB to be
                          considered a non-zero fee.
    --limitfreerelay=     Limit relay of transactions with no transaction fee
                          to the given amount in thousands of bytes per
                          minute (15)
    --norelaypriority     Do not require free or low-fee transactions to have
                          high priority for relaying
    --maxorphantx=        Max number of orphan transactions to keep in memory
                          (1000)
    --generate            Generate (mine) bitcoins using the CPU
    --miningaddr=         Add the specified payment address to the list of
                          addresses to use for generated blocks -- At least
                          one address is required if the generate option is
                          set
    --blockminsize=       Mininum block size in bytes to be used when creating
                          a block
    --blockmaxsize=       Maximum block size in bytes to be used when creating
                          a block (375000)
    --blockprioritysize=  Size in bytes for high-priority/low-fee transactions
                          when creating a block (20000)
    --getworkkey=         DEPRECATED -- Use the --miningaddr option instead
    --nonaggressive       Disable mining off of the parent block of the blockchain
                          if there aren't enough voters
    --nominingstatesync   Disable synchronizing the mining state with other nodes
    --allowoldvotes       Enable the addition of very old votes to the mempool

    --sigcachemaxsize=    The maximum number of entries in the signature
                          verification cache.
    --blocksonly          Do not accept transactions from remote peers.
    --acceptnonstd        Accept and relay non-standard transactions to
                          the network regardless of the default settings
                          for the active network.
    --rejectnonstd        Reject non-standard transactions regardless of the
                          default settings for the active network.
    --altdnsnames:        Specify additional dns names to use when
                          generating the rpc server certificate
                          [supports PFCD_ALT_DNSNAMES environment variable]

Help Options:

-h, --help           Show this help message

Directories

Path Synopsis
Package addrmgr implements concurrency safe Decred address manager.
Package addrmgr implements concurrency safe Decred address manager.
Package blockchain implements Decred block handling and chain selection rules.
Package blockchain implements Decred block handling and chain selection rules.
chaingen
Package chaingen provides facilities for generating a full chain of blocks.
Package chaingen provides facilities for generating a full chain of blocks.
fullblocktests
Package fullblocktests provides a set of block consensus validation tests.
Package fullblocktests provides a set of block consensus validation tests.
indexers
Package indexers implements optional block chain indexes.
Package indexers implements optional block chain indexes.
internal/dbnamespace
Package dbnamespace contains constants that define the database namespaces for the purpose of the blockchain, so that external callers may easily access this data.
Package dbnamespace contains constants that define the database namespaces for the purpose of the blockchain, so that external callers may easily access this data.
stake
Package stake contains code for all of dcrd's stake transaction chain handling and other portions related to the Proof-of-Stake (PoS) system.
Package stake contains code for all of dcrd's stake transaction chain handling and other portions related to the Proof-of-Stake (PoS) system.
stake/internal/dbnamespace
Package dbnamespace contains constants that define the database namespaces for the purpose of the blockchain, so that external callers may easily access this data.
Package dbnamespace contains constants that define the database namespaces for the purpose of the blockchain, so that external callers may easily access this data.
stake/internal/tickettreap
Package tickettreap implements a treap data structure that is used to hold live tickets ordered by their key along with some associated data using a combination of binary search tree and heap semantics.
Package tickettreap implements a treap data structure that is used to hold live tickets ordered by their key along with some associated data using a combination of binary search tree and heap semantics.
Package certgen includes a common base for creating a new TLS certificate key pair.
Package certgen includes a common base for creating a new TLS certificate key pair.
Package chaincfg defines chain configuration parameters.
Package chaincfg defines chain configuration parameters.
chainec
Package chainec provides wrapper functions to abstract the ec functions.
Package chainec provides wrapper functions to abstract the ec functions.
chainhash
Package chainhash provides abstracted hash functionality.
Package chainhash provides abstracted hash functionality.
cmd
Package connmgr implements a generic Decred network connection manager.
Package connmgr implements a generic Decred network connection manager.
Package database provides a block and metadata storage database.
Package database provides a block and metadata storage database.
ffldb
Package ffldb implements a driver for the database package that uses leveldb for the backing metadata and flat files for block storage.
Package ffldb implements a driver for the database package that uses leveldb for the backing metadata and flat files for block storage.
internal/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.
secp256k1
Package secp256k1 implements support for the elliptic curves needed for decred.
Package secp256k1 implements support for the elliptic curves needed for decred.
Package dcrjson provides primitives for working with the Decred JSON-RPC API.
Package dcrjson provides primitives for working with the Decred JSON-RPC API.
Package dcrutil provides decred-specific convenience functions and types.
Package dcrutil provides decred-specific convenience functions and types.
txsort
Package txsort provides stable transaction sorting.
Package txsort provides stable transaction sorting.
Package fees provides decred-specific methods for tracking and estimating fee rates for new transactions to be mined into the network.
Package fees provides decred-specific methods for tracking and estimating fee rates for new transactions to be mined into the network.
cmd/dumpfeedb
Tool dumpfeedb can be used to dump the internal state of the buckets of an estimator's feedb so that it can be externally analyzed.
Tool dumpfeedb can be used to dump the internal state of the buckets of an estimator's feedb so that it can be externally analyzed.
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.
blockcf
Package blockcf provides functions for building committed filters for blocks using Golomb-coded sets in a way that is useful for light clients such as SPV wallets.
Package blockcf provides functions for building committed filters for blocks using Golomb-coded sets in a way that is useful for light clients such as SPV wallets.
Package hdkeychain provides an API for Decred hierarchical deterministic extended keys (based on BIP0032).
Package hdkeychain provides an API for Decred hierarchical deterministic extended keys (based on BIP0032).
internal
limits
Package limits allows some process limits to be raised.
Package limits allows some process limits to be raised.
version
Package version provides a single location to house the version information for dcrd and other utilities provided in the same repository.
Package version provides a single location to house the version information for dcrd and other utilities provided in the same repository.
Package mempool provides a policy-enforced pool of unmined Decred transactions.
Package mempool provides a policy-enforced pool of unmined Decred transactions.
Package mining includes all mining and policy types, and will house all mining code in the future.
Package mining includes all mining and policy types, and will house all mining code in the future.
Package peer provides a common base for creating and managing Decred network peers.
Package peer provides a common base for creating and managing Decred network peers.
Package rpcclient implements a websocket-enabled Decred JSON-RPC client.
Package rpcclient implements a websocket-enabled Decred JSON-RPC client.
Package txscript implements the Decred transaction script language.
Package txscript implements the Decred transaction script language.
Package wire implements the Decred wire protocol.
Package wire implements the Decred wire protocol.

Jump to

Keyboard shortcuts

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