testing

.gitignore

@@ -1 +1,9 @@
 *.pyc
+conf/config.py
+NOTES
+run
+pooldb.sqlite
+archives/*
+twistd.pid
+.project
+.pydevproject

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "externals/stratum-mining-proxy"]
+	path = externals/stratum-mining-proxy
+	url = https://github.com/generalfault/stratum-mining-proxy.git

INSTALL

@@ -0,0 +1,100 @@
+Installation Instructions
+=========================
+
+Step 0: Install bitcoind
+	It MUST be a recent version of bitcoind that support getblocktemplate
+	Set it up and start it!
+	Downloading the blockchain can take a few hours to a couple days!
+
+Step 1: Install the stratum core
+	git pull https://github.com/slush0/stratum.git
+	sudo easy_install stratum
+	  (or if using alternate python: sudo /usr/local/bin/easy_install stratum)
+
+Step 2: Pull a copy of the miner
+	git pull https://github.com/generalfault/stratum-mining.git
+
+Step 3: Configure the Miner
+	cp conf/config_sample.py conf/config.py
+	make your changes to conf/config.py 
+	Make sure you set the values in BASIC SETTINGS! These are how to connect to bitcoind
+	  and where your money goes!
+
+Step 4: Run the pool
+	twistd -ny launcher.tac -l -
+	OR - using alternate python
+	/usr/local/bin/twistd -ny launcher.tac -l -
+
+You can now set the URL on your stratum proxy (or miner that supports stratum) to:
+http://YOURHOSTNAME:3333
+
+Bitcoind blocknotify Setup
+=========================
+Although scary (for me), this is actually pretty easy.
+
+Step 1: Set Admin Password
+	Ensure that you have set the ADMIN_PASSWORD_SHA256 parameter in conf/config.py
+	To make life easy you can run the generateAdminHash script to make the hash
+		./scripts/generateAdminHash.sh <password>
+
+Step 2: Test It
+	Restart the pool if it's already running
+	run ./scripts/blocknotify.sh --password <password> --host localhost --port 3333
+	Ensure everything is ok.
+
+Step 3: Run bitcoind with blocknotify
+	Stop bitcoind if it's already running
+	bitcoind stop
+	Wait till it ends
+	bitcoind -blocknotify="/absolute/path/to/scripts/blocknotify.sh --password <password> --host localhost --port 3333"
+
+Step 4: Adjust pool polling
+	Now you should be able to watch the pools debug messages for awhile and see the blocknotify come in
+	once you are sure it's working edit conf/config.py and set
+		PREVHASH_REFRESH_INTERVAL = to the same value as MERKLE_REFRESH_INTERVAL
+	restart the pool
+
+Database Setup
+=========================
+Table Creation: Tables are auto-created if they don't exist
+
+None:
+Well, this doesn't do anything, so there is nothing to set up
+
+Sqlite:
+THIS IS THE DEFAULT!
+Just set the file path in the config file (or keep the default.)
+Support for sqlite3 is built into recent python versions.
+A couple notes for Sqlite:
+	- Sqlite and threading/concurancy just doesn't work right for that reason it is disabled.
+	- Since threading is disabled, The server will "pause" when archiving happens, this will affect
+		your miners. However this will not happen often (24 hours after finding a share)
+
+Postgresql:
+1: Set up your parameters in the config file.
+2: Install the postgresql libraries in your os:
+	Redhat and the like:
+		yum install postgresql-libs postgresql-devel
+	Ubuntu and the like:
+		apt-get install postgresql postgresql-devel
+3: Install the python bindings
+	easy_install psycopg2
+
+Mysql:
+1: Set up your parameters in the config file.
+2: Install the postgresql libraries in your os:
+	Redhat and the like:
+		yum install mysql mysql-devel
+	Ubuntu and the like:
+		apt-get install mysql mysql-devel
+3: Install the python bindings
+	easy_install mysql-python
+
+Problems????
+=========================
+
+Is your firewall off?
+Is bitcoind running?
+
+TODO: are there other problems?
+

README.md

@@ -1,12 +1,42 @@
 stratum-mining
 ==============
 
-Demo implementation of bitcoin mining pool using Stratum mining protocol.
+Basic implementation of bitcoin mining pool using Stratum mining protocol.
 
-For Stratum mining protocol specification, please visit http://mining.bitcoin.cz/stratum-mining.
+This fork includes database optimisations for MySQL and password hashing using a salt.
 
-Contact
--------
+JSON API
+--------
 
-This pool implementation is provided by http://mining.bitcoin.cz. You can contact
-me by email info(at)bitcoin.cz or on IRC #stratum on freenode.
+There is also a JSON API, currently just for users (db: pool_workers). Enabled if you set 
+ADMIN_PORT to a valid port rather than None. Once enabled, you can perform 
+the following on http://localhost:ADMIN_PORT/, provided you have a password set (see after commands).
+
+GET /users - list all users
+POST /users - create a user (JSON body: {"username": "username", "password": "password"}). Password will be encrypted using the salt.
+
+GET /users/{id_or_username} - Get a JSON object of a specific user
+DELETE /users/{id_or_username} - Remove a pool_worker. If using MySQL, any shares associated with that user will be associated with the global system account (ID: 0)
+PUT /users/{id_or_username} - Update password for user, send as {"password": "password"}, as with POST /users, the password will be encrypted for you.
+
+### Authentication
+
+Access to the JSON API requires basic auth. The username does not matter; the password is the same as the ADMIN_PASSWORD_SHA256 password which 
+can generated using scripts/generateAdminHash.sh .
+
+I would strongly suggested locking down the port as well using iptables or similar.
+
+The Rest
+--------
+
+Basic worker stats are provided (and updated)
+
+See the INSTALL file for install instructions.
+
+For more info on Stratum:
+http://mining.bitcoin.cz/stratum-mining.
+
+Original version by Slush
+Modified version by GeneralFault
+
+This version by Wade Womersley (Media Skunk Works) ( Tips Welcome: 1FxBTbWR15WZp8vnru8N6zVsVBwigPAcdN )

TODO

@@ -0,0 +1,17 @@
+TODO File (in no particular order):
+
+SQL Connection pooling: sqlalchemy
+
+Add a "script" to add,list,disable users
+
+Variable difficulty should not be able to go higher than current difficulty
+
+Test NON-Local Coinbase with testnet in a box
+
+verify settings
+
+send e-mail on dead miner
+
+send e-mail on dead bitcoind
+
+