ballzcoin Goto Github PK

Official golang implementation of Ballzcoin.

Binary archives are published at https://ballzcoin.org/releases/.

Ballzcoin is based on Go Ethereum (Geth), with a number of modifications to the source. For prerequisites and detailed build instructions please read the Geth Installation Instructions on the Ethereum wiki.

Building ballzcoin requires both a Go (version 1.9 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

make ballzcoin

or, to build the full suite of utilities:

make all

The ballzcoin project comes with several wrappers/executables found in the cmd directory.

Going through all the possible command line flags is out of scope here, but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own Ballzcoin instance.

Please consult the Geth CLI Wiki page for a full list of command line options. All 'ballzcoin' command line options are the same as 'geth', however please note that there are no test nets on the Ballzcoin network.

By far the most common scenario is people wanting to simply interact with the Ballzcoin network: create accounts; transfer funds; deploy and interact with contracts. For this particular use-case the user doesn't care about years-old historical data, so we can fast-sync quickly to the current state of the network. To do so:

$ ballzcoin console

This command will:

• Start ballzcoin in fast sync mode (default, can be changed with the --syncmode flag), causing it to download more data in exchange for avoiding processing the entire history of the Ballzcoin network, which is very CPU intensive.
• Start up Ballzcoin's built-in interactive JavaScript console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as Ballzcoin's own management APIs. This too is optional and if you leave it out you can always attach to an already running Ballzcoin instance with ballzcoin attach.

As an alternative to passing the numerous flags to the geth binary, you can also pass a configuration file via:

$ ballzcoin --config /path/to/your_config.toml

To get an idea how the file should look like you can use the dumpconfig subcommand to export your existing configuration:

$ ballzcoin --your-favourite-flags dumpconfig

One of the quickest ways to get Ballzcoin up and running on your machine is by using Docker:

docker run -d --name ballzcoin-node -v /Users/alice/ballzcoin:/root \
           -p 8641:8641 -p 31805:31805 \
           ballzcoin/client-go

This will start ballzcoin in fast-sync mode with a DB memory allowance of 1GB just as the above command does. It will also create a persistent volume in your home directory for saving your blockchain as well as map the default ports. There is also an alpine tag available for a slim version of the image.

Do not forget --rpcaddr 0.0.0.0, if you want to access RPC from other containers and/or hosts. By default, ballzcoin binds to the local interface and RPC endpoints is not accessible from the outside.

As a developer, sooner rather than later you'll want to start interacting with Ballzcoin and the Ballzcoin network via your own programs and not manually through the console. To aid this, Ballzcoin has built-in support for a JSON-RPC based APIs (standard APIs and Ballzcoin specific APIs). These can be exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows).

The IPC interface is enabled by default and exposes all the APIs supported by Ballzcoin, whereas the HTTP and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. These can be turned on/off and configured as you'd expect.

HTTP based JSON-RPC API options:

• --rpc Enable the HTTP-RPC server
• --rpcaddr HTTP-RPC server listening interface (default: "localhost")
• --rpcport HTTP-RPC server listening port (default: 8641)
• --rpcapi API's offered over the HTTP-RPC interface (default: "eth,net,web3")
• --rpccorsdomain Comma separated list of domains from which to accept cross origin requests (browser enforced)
• --ws Enable the WS-RPC server
• --wsaddr WS-RPC server listening interface (default: "localhost")
• --wsport WS-RPC server listening port (default: 8642)
• --wsapi API's offered over the WS-RPC interface (default: "eth,net,web3")
• --wsorigins Origins from which to accept websockets requests
• --ipcdisable Disable the IPC-RPC server
• --ipcapi API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3")
• --ipcpath Filename for IPC socket/pipe within the datadir (explicit paths escape it)

You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect via HTTP, WS or IPC to a Ballzcoin node configured with the above flags and you'll need to speak JSON-RPC on all transports. You can reuse the same connection for multiple requests!

Note: Please understand the security implications of opening up an HTTP/WS based transport before doing so! Hackers on the internet are actively trying to subvert Ballzcoin nodes with exposed APIs! Further, all browser tabs can access locally running webservers, so malicious webpages could try to subvert locally available APIs!

Maintaining your own private network is more involved as a lot of configurations taken for granted in the official networks need to be manually set up.

First, you'll need to create the genesis state of your networks, which all nodes need to be aware of and agree upon. This consists of a small JSON file (e.g. call it genesis.json):

{
  "config": {
        "chainId": 0,
        "homesteadBlock": 0,
        "eip155Block": 0,
        "eip158Block": 0
    },
  "alloc"      : {},
  "coinbase"   : "0x0000000000000000000000000000000000000000",
  "difficulty" : "0x20000",
  "extraData"  : "",
  "gasLimit"   : "0x2fefd8",
  "nonce"      : "0x0000000000000042",
  "mixhash"    : "0x0000000000000000000000000000000000000000000000000000000000000000",
  "parentHash" : "0x0000000000000000000000000000000000000000000000000000000000000000",
  "timestamp"  : "0x00"
}

The above fields should be fine for most purposes, although we'd recommend changing the nonce to some random value so you prevent unknown remote nodes from being able to connect to you. If you'd like to pre-fund some accounts for easier testing, you can populate the alloc field with account configs:

"alloc": {
  "0x0000000000000000000000000000000000000001": {"balance": "111111111"},
  "0x0000000000000000000000000000000000000002": {"balance": "222222222"}
}

With the genesis state defined in the above JSON file, you'll need to initialize every Ballzcoin node with it prior to starting it up to ensure all blockchain parameters are correctly set:

$ ballzcoin init path/to/genesis.json

With all nodes that you want to run initialized to the desired genesis state, you'll need to start a bootstrap node that others can use to find each other in your network and/or over the internet. The clean way is to configure and run a dedicated bootnode:

$ bootnode --genkey=boot.key
$ bootnode --nodekey=boot.key

With the bootnode online, it will display an enode URL that other nodes can use to connect to it and exchange peer information. Make sure to replace the displayed IP address information (most probably [::]) with your externally accessible IP to get the actual enode URL.

Note: You could also use a full fledged Ballzcoin node as a bootnode, but it's the less recommended way.

With the bootnode operational and externally reachable (you can try netcat -u -z -v <ip> <port> to ensure it's indeed reachable), start every subsequent Ballzcoin node pointed to the bootnode for peer discovery via the --bootnodes flag. It will probably also be desirable to keep the data directory of your private network separated, so do also specify a custom --datadir flag.

$ ballzcoin --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above>

Note: Since your network will be completely cut off from the main network, you'll also need to configure a miner to process transactions and create new blocks for you.

Mining on the public Ballzcoin network is a complex task as it's only feasible using GPUs, requiring an OpenCL or CUDA enabled ethminer or claymore instance.

In a private network setting however, a single CPU miner instance is more than enough for practical purposes as it can produce a stable stream of blocks at the correct intervals without needing heavy resources (consider running on a single thread, no need for multiple ones either). To start a Ballzcoin instance for mining, run it with all your usual flags, extended by:

$ ballzcoin <usual-flags> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000

Which will start mining blocks and transactions on a single CPU thread, crediting all proceedings to the account specified by --etherbase. You can further tune the mining by changing the default gas limit blocks converge to (--targetgaslimit) and the price transactions are accepted at (--gasprice).

Alternatively run Ballzcoin in console mode:

$ ballzcoin console

And enter:

miner.start(x)

Where x is the number of threads (or leave as '()' for all CPU threads).

To stop mining, enter:

miner.stop()

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to Ballzcoin, please check up with the core devs first (get in touch via the links at the official website: https://ballzcoin.org) to ensure the changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please make sure your contributions adhere to our coding guidelines:

• Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
• Code must be documented adhering to the official Go commentary guidelines.
• Pull requests need to be based on and opened against the master branch.
• Commit messages should be prefixed with the package(s) they modify.
  • E.g. "eth, rpc: make trace configs optional"

Please see the Ethereum Developers' Guide for more details on configuring your environment, managing project dependencies and testing procedures.

The ballzcoin library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The ballzcoin binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.