README.md

pfcd

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 the 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:

• Git

  Installation instructions can be found at https://git-scm.com or https://gitforwindows.org.

• Go 1.13

  Installation instructions can be found here: https://golang.org/doc/install. It is recommended to add $GOPATH/bin to your PATH at this point.

• 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 default node:

pfcd

Launch mining node (set your wallet address):

pfcd --generate --miningaddr "JsKFRL5ivSH7CnYaTtaBT4M9fZG878g49Fg"

Launch 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 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.