Skip to content

fakecoinbase/classzzslashclasszz

Repository files navigation

classzz

Build Status Go Report Card ISC License GoDoc

classzz is an alternative full node bitcoin cash implementation written in Go (golang).

This project is a port of the btcd codebase to Bitcoin Cash. It provides a high powered and reliable blockchain server which makes it a suitable backend to serve blockchain data to lite clients and block explorers or to power your local wallet.

classzz does not include any wallet functionality by design as it makes the codebase more modular and easy to maintain. The czzwallet is a separate application that provides a secure Bitcoin Cash wallet that communicates with your running classzz instance via the API.

Table of Contents

Requirements

Go 1.9 or newer.

Install

Install Pre-built Packages

The easiest way to run the server is to download a pre-built binary. You can find binaries of our latest release for each operating system at the releases page.

Build from Source

If you prefer to install from source do the following:

  • Install Go according to the installation instructions here: http://golang.org/doc/install

  • Run the following commands to obtain btcd, all dependencies, and install it:

go get github.com/classzz/classzz

This will download and compile classzz and put it in your path.

If you are a classzz contributor and would like to change the default config file (classzz.conf), make any changes to sample-classzz.conf and then run the following commands:

go-bindata sample-classzz.conf  # requires github.com/go-bindata/go-bindata/
gofmt -s -w bindata.go

Getting Started

The V2.0 main network needs to download dogecoin and litecoin nodes and enable RPC services.

Dogecoin node configuration example:

server = 1
rpcuser =root # RPC user name
rpcpassword = admin # RPC password
rpcallowip =127.0.0.1 # need to enable all access to 0.0.0.0/0
rpcbind = 0.0.0.0
rpcport = 9999 # RPC ports
txindex = 1

Litecoin node configuration example:

server=1
rpcuser=root # RPC user name
rpcpassword=admin # RPC password
rpcallowip=127.0.0.1 # need to enable all access to 0.0.0.0/0
rpcbind=0.0.0.0
rpcport=19200 # RPC ports
txindex=1

To start classzz with default options just run:

./czzd

You'll find a large number of runtime options with the help flag. All of them can also be set in a config file. See the sample config file for an example of how to use it.

./czzd --help

You can use the common json RPC interface through the czzctl command:

./czzctl --help

./czzctl --listcommands

Classzz separates the node and the wallet. Commands for the wallet will work when you are also running czzwallet:

./czzctl -u username -P password --wallet getnewaddress

Documentation

The documentation is a work-in-progress. It is located in the docs folder.

Contributing

Contributions are definitely welcome! Please read the contributing guidelines before starting.

License

classzz is licensed under the copyfree ISC License.

About

This is your first repository

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages