README

   1 Eloipool - Python Bitcoin pool server
   2 Copyright (C) 2011-2013  Luke Dashjr <luke-jr+eloipool@utopios.org>
   3
   4
   5 Copyright License
   6 -----------------
   7 This program is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU Affero General Public License as
   9 published by the Free Software Foundation, either version 3 of the
  10 License, or (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU Affero General Public License for more details.
  16
  17 You should have received a copy of the GNU Affero General Public License
  18 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21 Dependencies
  22 ------------
  23 Python 3.2+                     http://python.org
  24 python-bitcoinrpc       https://github.com/jgarzik/python-bitcoinrpc
  25 python-base58           https://gitorious.org/bitcoin/python-base58
  26
  27 Optional Dependencies
  28 ---------------------
  29 midstate                        http://gitorious.org/midstate/midstate
  30 Psycopg2                        http://initd.org/psycopg/
  31 PyMySQL                         http://www.pymysql.org/
  32
  33
  34 Merged Mining
  35 -------------
  36 Eloipool supports merged mining using the setworkaux/gotwork RPC interface.
  37 A simple port of namecoin's merged-mine-proxy to this interface is available
  38 here:
  39         https://gitorious.org/~Luke-Jr/bitcoin/luke-jr-bitcoin/blobs/namecoin_mmm/contrib/merged-mine-proxy
  40 Please be advised that:
  41 - Eloipool does not provide any interface for longpolling aux chains.
  42 - Empty and longpoll merkle roots are generated only as-needed, and will NOT be
  43   regenerated when CoinbaseAux changes. This means shares found by getwork
  44   miners after a longpoll will almost always be stale on your aux chain(s).
  45   This problem does not affect GBT or stratum miners.