Official golang implementation of the WhaleCoin protocol.
Branch: master
Clone or download
Latest commit 2cd1fe0 Jun 1, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
accounts Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
build Changing Port to 30373 Aug 31, 2017
cmd Removing Rinkeby Testnet References Sep 4, 2017
common Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
compression/rle Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
consensus updating Founder Fork block May 31, 2018
console Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
containers Changing Port to 30373 Aug 31, 2017
contracts Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
core Updated genesis config and hash Sep 4, 2017
crypto Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
eth Update Network ID Aug 31, 2017
ethclient Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
ethdb Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
ethstats Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
event Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
internal Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
les Update NetworkID to 30373 Aug 31, 2017
light Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
log Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
metrics Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
miner Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
mobile Change UDP dicovery Port Aug 31, 2017
node Changing Port to 30373 Aug 31, 2017
p2p Change UDP dicovery Port Aug 31, 2017
params updating version patch Jun 1, 2018
rlp rlp, trie, contracts, compression, consensus: improve comments (#14580) Jun 12, 2017
rpc Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
swarm Change UDP dicovery Port Aug 31, 2017
tests Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
trie Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
vendor Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
whisper Changing Port to 30373 Aug 31, 2017
.dockerignore dockerignore: ignore all git metadata and all tests Jul 11, 2017
.gitattributes .gitattributes: add Aug 6, 2015
.gitignore Godeps, vendor: convert dependency management to trash (#3198) Oct 28, 2016
.gitmodules tests: update tests and implement general state tests (#14734) Jul 11, 2017
.mailmap all: update license information Apr 14, 2017
.travis.yml Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017
AUTHORS all: update license information Apr 14, 2017
COPYING all: update license information Jul 7, 2015
COPYING.LESSER all: update license information Jul 7, 2015
Dockerfile Changing Port to 30373 Aug 31, 2017
Makefile Rebranding geth to gwhale Aug 29, 2017
README.md update readme Sep 27, 2017
VERSION updated version May 31, 2018
appveyor.yml tests: update tests and implement general state tests (#14734) Jul 11, 2017
circle.yml circleci: enable docker based hive testing Jul 15, 2016
genesis.json Changes Default Genesis Sep 4, 2017
interfaces.go Rebranding directory from ethereum/go-ethereum to WhaleCoinOrg/WhaleCoin Aug 29, 2017

README.md

WhaleCoin

Official golang implementation of the WhaleCoin protocol.

WhaleCoin Rocket Chat

Wallets

Latest release of the Desktop Wallets at:

https://github.com/WhaleCoinOrg/DesktopWallet/releases

https://blog.whalecoin.org/whalecoin-wallet-desktop-wallet-walk-through-a9bc94f6c26f

Web Wallet

We recommend:

https://mywhalewallet.com/

https://blog.whalecoin.org/how-to-create-and-use-a-whalewallet-c4e627a5fdf9

Installation On Remote Server (Ubuntu 16.04)

sudo apt-get update
sudo apt-get -y upgrade
sudo curl -O https://storage.googleapis.com/golang/go1.8.3.linux-amd64.tar.gz
sudo tar -xvf go1.8.3.linux-amd64.tar.gz
sudo mv go /usr/local
nano ~/.profile
Add export PATH=$PATH:/usr/local/go/bin to the file
source ~/.profile
git clone https://github.com/WhaleCoinOrg/WhaleCoin.git
sudo apt-get install -y build-essential
cd WhaleCoin
make gwhale
./build/bin/gwhale account new
./build/bin/gwhale

Building the source

For prerequisites and detailed build instructions please read the Installation Instructions on the wiki.

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

make gwhale

or, to build the full suite of utilities:

make all

Executables

The go-ethereum project comes with several wrappers/executables found in the cmd directory.

Command Description
gwhale Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default) archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. gwhale --help and the CLI Wiki page for command line options.
abigen Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain Ethereum contract ABIs with expanded functionality if the contract bytecode is also available. However it also accepts Solidity source files, making development much more streamlined. Please see our Native DApps wiki page for details.
bootnode Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks.
disasm Bytecode disassembler to convert EVM (Ethereum Virtual Machine) bytecode into more user friendly assembly-like opcodes (e.g. `echo "6001"
evm Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow insolated, fine-grained debugging of EVM opcodes (e.g. evm --code 60ff60ff --debug).
gethrpctest Developer utility tool to support our ethereum/rpc-test test suite which validates baseline conformity to the Ethereum JSON RPC specs. Please see the test suite's readme for details.
rlpdump Developer utility tool to convert binary RLP (Recursive Length Prefix) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user friendlier hierarchical representation (e.g. rlpdump --hex CE0183FFFFFFC4C304050583616263).
swarm swarm daemon and tools. This is the entrypoint for the swarm network. swarm --help for command line options and subcommands. See https://swarm-guide.readthedocs.io for swarm documentation.

Running gwhale

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 Geth instance.

Full node on the main WhaleCoin network

By far the most common scenario is people wanting to simply interact with the Ethereum 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:

$ gwhale --fast --cache=512 console

This command will:

  • Start geth in fast sync mode (--fast), causing it to download more data in exchange for avoiding processing the entire history of the Ethereum network, which is very CPU intensive.
  • Bump the memory allowance of the database to 512MB (--cache=512), which can help significantly in sync times especially for HDD users. This flag is optional and you can set it as high or as low as you'd like, though we'd recommend the 512MB - 2GB range.
  • Start up Geth's built-in interactive JavaScript console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as Geth's own management APIs. This too is optional and if you leave it out you can always attach to an already running Geth instance with geth attach.

Full node on the Ethereum test network

Transitioning towards developers, if you'd like to play around with creating Ethereum contracts, you almost certainly would like to do that without any real money involved until you get the hang of the entire system. In other words, instead of attaching to the main network, you want to join the test network with your node, which is fully equivalent to the main network, but with play-Ether only.

$ gwhale --testnet --fast --cache=512 console

The --fast, --cache flags and console subcommand have the exact same meaning as above and they are equally useful on the testnet too. Please see above for their explanations if you've skipped to here.

Specifying the --testnet flag however will reconfigure your Geth instance a bit:

  • Instead of using the default data directory (~/.ethereum on Linux for example), Geth will nest itself one level deeper into a testnet subfolder (~/.ethereum/testnet on Linux). Note, on OSX and Linux this also means that attaching to a running testnet node requires the use of a custom endpoint since geth attach will try to attach to a production node endpoint by default. E.g. geth attach <datadir>/testnet/gwhale.ipc. Windows users are not affected by this.
  • Instead of connecting the main Ethereum network, the client will connect to the test network, which uses different P2P bootnodes, different network IDs and genesis states.

Note: Although there are some internal protective measures to prevent transactions from crossing over between the main network and test network, you should make sure to always use separate accounts for play-money and real-money. Unless you manually move accounts, Geth will by default correctly separate the two networks and will not make any accounts available between them.

Configuration

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

$ gwhale --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:

$ gwhale --your-favourite-flags dumpconfig

Note: This works only with geth v1.6.0 and above

Programatically interfacing gWhale nodes

As a developer, sooner rather than later you'll want to start interacting with Geth and the Ethereum network via your own programs and not manually through the console. To aid this, Geth has built in support for a JSON-RPC based APIs (standard APIs and Geth 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 Geth, 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: 8545)
  • --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: 8546)
  • --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 Geth 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 Ethereum nodes with exposed APIs! Further, all browser tabs can access locally running webservers, so malicious webpages could try to subvert locally available APIs!

Operating a private network

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.

Creating the rendezvous point

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 Geth node as a bootnode, but it's the less recommended way.

Starting up your member nodes

With the bootnode operational and externally reachable (you can try telnet <ip> <port> to ensure it's indeed reachable), start every subsequent Geth 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.

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

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

Running a private miner

Mining on the public WhaleCoin network is a complex task as it's only feasible using GPUs, requiring an OpenCL or CUDA enabled ethminer instance. For information on such a setup, please consult the EtherMining subreddit and the Genoil miner repository.

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 gWhale instance for mining, run it with all your usual flags, extended by:

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

Which will start mining bocks 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).

Contribution

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 WhaleCoin, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our rocket chat to ensure those 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 Developers' Guide for more details on configuring your environment, managing project dependencies and testing procedures.

License

The go-ethereum 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 go-ethereum 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.