Merge pull request #348 from CoiniumServ/develop

Sync master with develop branch for very first release.

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "deps/jsonconfig"]
 	path = deps/jsonconfig
 	url = https://github.com/CoiniumServ/JsonConfig.git
+[submodule "deps/csredis"]
+	path = deps/csredis
+	url = https://github.com/CoiniumServ/csredis.git

.travis.yml

@@ -1,27 +1,16 @@
 language: objective-c
 env:
   global:
-  - secure: "jan4aHikK+XOsBfJrhbFnrFlhAJ7p31z2KiXxoviFmO+5gIsZuhaEIniA5Kx/27rakj0CphoXxGL77WAYiEuVGJKl5j2j55zCYxSrs3ux7OuDut7A3NmwFXD65XcU75Pj12O3YMN96FKSY1ESdf0SBnti+hvgGDgIM47MOFWxME="
   - EnableNuGetPackageRestore=true
   matrix:
   - MONO_VER="3.2.7" Package="pkg"
   - MONO_VER="3.4.0" Package="pkg"
 before_install:
 - wget "http://download.mono-project.com/archive/${MONO_VER}/macos-10-x86/MonoFramework-MDK-${MONO_VER}.macos10.xamarin.x86.${Package}"
-- chmod +x ./build/extra/travis-build.sh
-- ./build/extra/travis-build.sh
+- ./build/extra/travis/install-mono.sh
 script:
 - xbuild build/CoiniumServ.sln
-- chmod +x ./build/extra/run-tests.sh
-- ./build/extra/run-tests.sh
+- ./build/extra/travis/run-tests.sh
 notifications:
-  irc: chat.freenode.net#coinium-dev
+  irc: chat.freenode.net#coiniumserv-dev
   email: false
-addons:
-  coverity_scan:
-    project:
-      name: CoiniumServ/CoiniumServ
-      description: C# Mono/.Net based crypto currency mining pool software
-    build_command_prepend: 
-    build_command: xbuild build/CoiniumServ.sln
-    branch_pattern: coverity_scan

README.md

@@ -5,29 +5,115 @@
 CoiniumServ was created to be used for [Coinium.org](http://www.coinium.org) mining pool network at first hand. You can check [some of pools](https://github.com/CoiniumServ/CoiniumServ/wiki/Pools) of the pools running CoiniumServ.
 
 * Official pools: [coinium.org](http://www.coinium.org)
-* Official site: [coiniumserv.com](http://www.coiniumserv.com)
 
 ![CoiniumServ running over mono & ubuntu](http://i.imgur.com/izIB5nq.png)
 
+### Support
+
+Start by reading our [FAQ](https://github.com/CoiniumServ/CoiniumServ/wiki/FAQ) and [wiki](https://github.com/CoiniumServ/CoiniumServ/wiki/). If you need further help, join us over our user-support channel [#coiniumserv@freenode](http://webchat.freenode.net/?channels=%23coiniumserv&prompt=1&uio=OT10cnVlde).
+
+You can also use our [issues](https://github.com/CoiniumServ/CoiniumServ/issues) page to report bugs.
+
+* Official site: [coiniumserv.com](http://www.coiniumserv.com)
+* [Support forums](http://forum.coinium.org/forum/19-support/)
+* IRC (**irc.freenode.net**):
+  - **#coiniumserv** [user support](http://webchat.freenode.net/?channels=%23coiniumserv&prompt=1&uio=OT10cnVlde)
+  - **#coiniumserv-dev** [dev talk](http://webchat.freenode.net/?channels=%23coiniumserv-dev&prompt=1&uio=OT10cnVlde)
+  - **#coinium** [official pools](http://webchat.freenode.net/?channels=%23coinium&prompt=1&uio=OT10cnVlde)
+* [Twitter](http://twitter.com/coinium)
+* [Bitcointalk.org](https://bitcointalk.org/index.php?topic=604476.0)
+* [Bitcoin wiki](https://en.bitcoin.it/wiki/CoiniumServ)
+
+### Donation
+
+You can contribute the development of the project by donating; 
+
+* BTC: `18qqrtR4xHujLKf9oqiCsjmwmH5vGpch4D`
+* LTC: `LMXfRb3w8cMUBfqZb6RUkFTPaT6vbRozPa`
+* DOGE: `DM8FW8REMHj3P4xtcMWDn33ccjikCWJnQr`
+* RDD: `Rb9kcLs96VDHTmiXVjcWC2RBsfCJ73UQyr`
+
+If you would like to automatically donate a percentage of your pool's earning to support the project, check the [donation setup](https://github.com/CoiniumServ/CoiniumServ/wiki/Donation) guide.
+
+###### Donors
+
+Here is a list of our generous donors that keep the project ongoing;
+
+* [reddapi.com](https://www.reddapi.com)
+
+###### Bounties
+
+BountySource integration available over [here](https://www.bountysource.com/trackers/401667-coiniumserv). You can set bounties and solve them.
+
+[![Bountysource](https://api.bountysource.com/badge/team?team_id=760&style=bounties_received)](https://www.bountysource.com/teams/coinium/issues?utm_source=Coinium&utm_medium=shield&utm_campaign=TEAM_BADGE_1)
+
+###### Tips
+
+You can send tips and furher support the project or get tips for contributing by commiting.
+
+[![tip for next commit](http://tip4commit.com/projects/760.svg)](http://tip4commit.com/projects/760)
+
+### Status
+
+Expect a functioning alpha soon.
+
 ### Features
 
 ###### Platform Agnostic
-Can run on any platforms that C# can live in;
-* *nix (including Linux) over mono
-* Windows over DotNet.
+Can run on these platforms;
+* Linux/Unix over [mono](http://www.mono-project.com/).
+* MacOS over [mono](http://www.mono-project.com/).
+* Windows over [.Net](http://www.microsoft.com/net).
 
 ###### Multiplexed Structure
 * Multiple pools & ports.
-* Multi-pool (switched) mining support.
-* Multiple coin daemon connections.
+* Multiple coin daemon connection support.
 * Multiple database layers.
 
 ###### Functionality
-* Stratum server (over sockets) support. [in-development]
-* Vanilla server (getwork & getblocktemplate over http server) support. [in-development]
+* Stratum server (over TCP sockets).
+* Stratum show_message support (MOTD & messages).
+* Vanilla server (getwork over http server). [experimental]
+* Daemon RPC interface.
+* Block template / job managment.
+* Generation transaction builder.
+* Share processor.
+* Payment processor.
+* Proof of Work (PoW) and Proof of Stake (PoS) [in-development] support.
+* Transaction messages support [in-development].
+* Vardiff support.
+* Ban manager support that can handles miners flooding with invalid shares.
+* Embedded web-server & front-end
+* Full-stack API
+
+###### Hashing Algorithms
+
+_Working_
+* ✓ __Scrypt__ 
+
+_Needs Testing_
+
+* ✓ __SHA256__ 
+* ✓ __Blake__
+* ✓ __Fugue__
+* ✓ __Groestl__
+* ✓ __Keccak__ 
+* ✓ __SHAvite3__
+* ✓ __Skein__ 
+* ✓ __multi-algos: X11, X13, X14, X15, X17__
+
+_Under Development_
+
+* ✓ __Scrypt-Jane__ 
+* ✓ __Scrypt-N__ 
+* ✓ __Scrypt-OG__ 
+* ✓ __Quark__ 
+* ✓ __NIST5__
+* ✓ __Qubit__
+* ✓ __Hefty1__
 
 ###### Development Model
-* Strictly [follows](https://github.com/CoiniumServ/CoiniumServ/tree/develop/src/Tests) the [Test Driven Development](http://en.wikipedia.org/wiki/Test-driven_development) model. We have implemented extensive tests for all important functionality and never merge in code that breaks tests and stuff. Yet again, when a new functionality is introduced we also expect proper tests to be implemented within the PR. In simple words, most probably you won't notice any functionality-breaking changes within the repository.
+* Strictly [follows](https://github.com/CoiniumServ/CoiniumServ/tree/develop/src/Tests) the [Test Driven Development](http://en.wikipedia.org/wiki/Test-driven_development) model. We have implemented extensive [tests](https://github.com/CoiniumServ/CoiniumServ/tree/develop/src/Tests) for all important functionality and never merge in code that breaks tests and stuff. Yet again, when a new functionality is introduced we also expect proper tests to be implemented within the PR. In simple words, most probably you won't notice any functionality-breaking changes within the repository.
 * A strict ruleset for the [Development Model](https://github.com/CoiniumServ/CoiniumServ/wiki/Development-Model). You can follow our bleeding-edge [Develop](https://github.com/CoiniumServ/CoiniumServ) branch or stay with-in the stable [Master](https://github.com/CoiniumServ/CoiniumServ/tree/master) branch.
 
 
@@ -38,27 +124,14 @@ Make sure you check our [Getting Started](https://github.com/CoiniumServ/Coinium
 For Ubuntu, you can simply use our installer script;
 
 ```
-wget -O - https://raw.githubusercontent.com/CoiniumServ/CoiniumServ/develop/assets/installer/ubuntu.sh | bash
+wget -O - https://raw.githubusercontent.com/CoiniumServ/CoiniumServ/develop/contrib/installers/ubuntu.sh | bash
 ```
 
 ### Documentation
 
-* [Documentation & Wiki](https://github.com/CoiniumServ/CoiniumServ/wiki/)
+* [Wiki](https://github.com/CoiniumServ/CoiniumServ/wiki/)
 * [FAQ](https://github.com/CoiniumServ/CoiniumServ/wiki/FAQ)
-* [Master Plan](https://github.com/CoiniumServ/CoiniumServ/wiki/Master-Plan) ( & motivation)
-
-### Support
-
-Start by reading our [FAQ](https://github.com/CoiniumServ/CoiniumServ/wiki/FAQ) and [wiki](https://github.com/CoiniumServ/CoiniumServ/wiki/). If you need further help, join us over our user-support channel [#coinium-serv@freenode](http://webchat.freenode.net/?channels=%23coinium-serv&prompt=1&uio=OT10cnVlde).
-
-You can also use our [issues](https://github.com/CoiniumServ/CoiniumServ/issues) page to report bugs.
-
-* IRC (**irc.freenode.net**):
-  - **#coinium-serv** [user support](http://webchat.freenode.net/?channels=%23coinium-serv&prompt=1&uio=OT10cnVlde)
-  - **#coinium-dev** [dev talk](http://webchat.freenode.net/?channels=%23coinium-dev&prompt=1&uio=OT10cnVlde)
-  - **#coinium** [official pools](http://webchat.freenode.net/?channels=%23coinium&prompt=1&uio=OT10cnVlde)
-* [Twitter](http://twitter.com/coinium)
-* [Bitcointalk.org](https://bitcointalk.org/index.php?topic=604476.0)
+* [Master Plan](https://github.com/CoiniumServ/CoiniumServ/wiki/Master-Plan)
 
 ### Contributing
 
@@ -67,29 +140,10 @@ Start reading by these;
 * [Developer's Guide](https://github.com/CoiniumServ/CoiniumServ/wiki/Developer's-Guide)
 * [Technical Documentation](https://github.com/CoiniumServ/CoiniumServ/wiki/Technical-Documentation)
 
-### Donation
-
-You can contribute the development of the project by donating; 
-
-* BTC: `18qqrtR4xHujLKf9oqiCsjmwmH5vGpch4D`
-* LTC: `LMXfRb3w8cMUBfqZb6RUkFTPaT6vbRozPa`
-* DOGE: `D7mzHQtkWD9B1Xwnmjfg9x2DofbaZBg6Lc`
-
-###### Bounties
-
-BountySource integration available over [here](https://www.bountysource.com/trackers/401667-coiniumserv). You can set bounties and solve them.
-
-[![Bountysource](https://api.bountysource.com/badge/team?team_id=760&style=bounties_received)](https://www.bountysource.com/teams/coinium/issues?utm_source=Coinium&utm_medium=shield&utm_campaign=TEAM_BADGE_1)
-
-###### Tips
-
-You can send tips and furher support the project or get tips for contributing by commiting.
-
-[![tip for next commit](http://tip4commit.com/projects/760.svg)](http://tip4commit.com/projects/760)
-
 ### License
 
-Copyright (C) 2013 - 2014, Coinium & CoiniumServ Project - http://www.coinium.org
+Copyright (C) 2013 - 2014, CoiniumServ Project - http://www.coinium.org - 
+http://www.coiniumserv.com - https://github.com/CoiniumServ/CoiniumServ
 
 This software is dual-licensed: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -104,5 +158,5 @@ GNU General Public License for more details.
 For the terms of this license, see [licenses/gpl_v3.txt](https://github.com/CoiniumServ/CoiniumServ/blob/develop/licenses/gpl_v3.txt).
 
 Alternatively, you can license this software under a commercial
-license or white-label it as set out in [licenses/commercial.txt](https://github.com/CoiniumServ/CoiniumServ/blob/develop/licenses/commercial.txt).
+license or white-label it as set out in [licenses/commercial.md](https://github.com/CoiniumServ/CoiniumServ/blob/develop/licenses/commercial.md).
 

build/.gitignore

@@ -1,2 +1,2 @@
 /*.sln.DotSettings
-*.userprefs
+*.userprefs