This document is an easy to follow guide to installing and running your own Electrum server on Linux. It is structured as a series of steps you need to follow, ordered in the most logical way. The next two sections describe some conventions we use in this document and hardware, software and expertise requirements.
-The most up-to date version of this document is available at: https://gitorious.org/electrum/electrum/blobs/master/server/HOWTO
-
+The most up-to date version of this document is available at: https://gitorious.org/electrum/server/blobs/master/HOWTO
Conventions
We will download the latest git snapshot for Electrum and 'install' it in our ~/bin directory:
-$ cd ~/src
-$ git clone git://gitorious.org/electrum/electrum.git
+$ mkdir -p ~/src/electrum
+$ cd ~/src/electrum
+$ git://gitorious.org/electrum/server.git
$ chmod +x ~/src/electrum/server/server.py
-$ ln -s ~/src/electrum/server/server.py ~/bin/electrum-server
+$ ln -s ~/src/electrum/server/server.py ~/bin/electrum
Step 2. Install a patched version of bitcoind
Electrum server requires some small modifications to the bitcoind daemon. The patch is included in the Electrum sources we just downloaded, now we will download the Bitcoin sources, patch, compile and install the binary to our ~/bin directory.
$ cd ~/src
-$ wget https://github.com/bitcoin/bitcoin/tarball/v0.5.2 -O bitcoin-0.5.2.tgz
-$ tar xvzf bitcoin-0.5.2.tgz
-$ mv bitcoin-bitcoin-fb24b05 bitcoin-0.5.2
-$ cd bitcoin-0.5.2/src
-$ patch -p 2 < ~/src/electrum/server/patches/bitcoin-0.5.2.diff
+$ wget https://github.com/bitcoin/bitcoin/tarball/v0.6.0 -O bitcoin-0.6.0.tgz
+$ tar xvzf bitcoin-0.6.0.tgz
+$ mv bitcoin-bitcoin-b3b5ab1 bitcoin-0.6.0
+$ cd bitcoin-0.6.0/src
+$ patch -p 2 < ~/src/electrum/server/patches/bitcoin-0.6.0.diff
$ make -f makefile.unix
$ strip bitcoind
$ mv bitcoind ~/bin
-Step 3. Configure and start bitcoind.
+Step 3. Configure and start bitcoind
In order to allow Electrum to "talk" to bitcoind, we need to set up a RPC username and password for bitcoind. We will then start bitcoind and wait for it to complete downloading the blockchain.
$ git clone git://github.com/jtobey/bitcoin-abe.git
$ cd bitcoin-abe
$ sudo python setup.py install
+# Please note that the path below might be slightly different on your system,
+# for example python2.6 or 2.8
$ sudo chmod +x /usr/local/lib/python2.7/dist-packages/Abe/abe.py
$ ln -s /usr/local/lib/python2.7/dist-packages/Abe/abe.py ~/bin/abe
It means the blockchain is imported and you can exit Abe by pressing CTRL-C. You will not need to run Abe again after this step, Electrum server will update the blockchain by itsself. We only used Abe because it is much faster for the initial import.
-Important notice: This is a *very* long process. Even on fast machines you can expect it to take hours. Here are some benchmarks for importing ~159.400 blocks (size of the Bitcoin blockchain at the time of this writing):
+Important notice: This is a *very* long process. Even on fast machines you can expect it to take hours. Here are some benchmarks for importing ~173.000 blocks (size of the Bitcoin blockchain at the time of this writing):
-System 1: ~8 hours.
+System 1: ~9 hours.
* CPU: Intel Core i7 Q740 @ 1.73GHz
* HDD: very fast SSD
-System 2: ~48 hours.
+System 2: ~55 hours.
* CPU: Intel Xeon X3430 @ 2.40GHz
* HDD: 2 x SATA in a RAID1.
$ sudo cp ~/src/electrum/server/electrum.conf.sample /etc/electrum.conf
$ sudo $EDITOR /etc/electrum.conf
- # sample server config for a public Electrum server
+ # sample config for a public Electrum server
[server]
host = host-fqdn
- port = 50000
+ native_port = 50000
+ stratum_tcp_port:50001
+ stratum_http_port:8081
password = <electrum-server-password>
banner = Welcome to Electrum server!
irc = yes
- ircname = public Electrum server
+ irc_nick = MyNick
cache = yes
- # sample server config for a private (does not advertise on IRC) Electrum server
+ # sample config for a private server (does not advertise on IRC)
[server]
host = localhost
- port = 50000
+ native_port = 50000
+ stratum_tcp_port:50001
+ stratum_http_port:8081
password = <electrum-server-password>
- banner = Welcome to Electrum server!
+ banner = Welcome to my private Electrum server!
irc = no
- ircname = foo
+ irc_nick = foo
cache = yes
# database setup - MySQL
--- /dev/null
+diff -ur bitcoin-0.6.0/src/bitcoinrpc.cpp bitcoin-0.6.0-electrum/src/bitcoinrpc.cpp
+--- bitcoin-0.6.0/src/bitcoinrpc.cpp 2012-03-29 22:11:04.000000000 +0300
++++ bitcoin-0.6.0-electrum/src/bitcoinrpc.cpp 2012-03-31 12:30:50.631339067 +0300
+@@ -1486,7 +1486,43 @@
+ return entry;
+ }
+
++Value importtransaction(const Array& params, bool fHelp)
++{
++ string hexdump;
++ if (fHelp || params.size() != 1 || (hexdump=params[0].get_str()).size()&1)
++ throw runtime_error(
++ "importtransaction <hexdata>\n"
++ "Import an offline transaction to announce it into the network");
++
++ std::vector<unsigned char> rawtx;
++ for (int i=0; i<hexdump.size(); i+=2)
++ {
++ int v;
++ if (sscanf(hexdump.substr(i,2).c_str(), "%x", &v)!=1)
++ throw JSONRPCError(-4, "Error in hex data.");
++ rawtx.push_back((unsigned char)v);
++ }
++try
++ {
++ CDataStream ss(rawtx);
++ CTransaction tx;
++ ss >> tx;
++ CInv inv(MSG_TX, tx.GetHash());
++ if(! tx.AcceptToMemoryPool(true)) throw JSONRPCError(-4, "Transaction not accepted to memory pool.");
++ CDataStream msg(rawtx);
++ RelayMessage(inv, msg);
++ return tx.GetHash().GetHex();
++ }
++ catch (std::exception& e)
++ {
++ throw JSONRPCError(-4, "Exception while parsing the transaction data.");
++ }
++
++}
++
++
+
++
+ Value backupwallet(const Array& params, bool fHelp)
+ {
+ if (fHelp || params.size() != 1)
+@@ -2047,7 +2083,8 @@
+ make_pair("getmemorypool", &getmemorypool),
+ make_pair("listsinceblock", &listsinceblock),
+ make_pair("dumpprivkey", &dumpprivkey),
+- make_pair("importprivkey", &importprivkey)
++ make_pair("importprivkey", &importprivkey),
++ make_pair("importtransaction", &importtransaction)
+ };
+ map<string, rpcfn_type> mapCallTable(pCallTable, pCallTable + sizeof(pCallTable)/sizeof(pCallTable[0]));
+
+diff -ur bitcoin-0.6.0/src/main.cpp bitcoin-0.6.0-electrum/src/main.cpp
+--- bitcoin-0.6.0/src/main.cpp 2012-03-29 22:11:04.000000000 +0300
++++ bitcoin-0.6.0-electrum/src/main.cpp 2012-03-31 12:36:41.711339168 +0300
+@@ -3164,18 +3164,21 @@
+
+ // Size limits
+ unsigned int nTxSize = ::GetSerializeSize(tx, SER_NETWORK);
+- if (nBlockSize + nTxSize >= MAX_BLOCK_SIZE_GEN)
+- continue;
++ //if (nBlockSize + nTxSize >= MAX_BLOCK_SIZE_GEN)
++ // continue;
+
+ // Legacy limits on sigOps:
+ int nTxSigOps = tx.GetLegacySigOpCount();
+- if (nBlockSigOps + nTxSigOps >= MAX_BLOCK_SIGOPS)
+- continue;
++ //if (nBlockSigOps + nTxSigOps >= MAX_BLOCK_SIGOPS)
++ // continue;
+
+ // Transaction fee required depends on block size
+ bool fAllowFree = (nBlockSize + nTxSize < 4000 || CTransaction::AllowFree(dPriority));
+ int64 nMinFee = tx.GetMinFee(nBlockSize, fAllowFree, GMF_BLOCK);
+
++ // Electrum server: do not check fees
++ nMinFee = 0;
++
+ // Connecting shouldn't fail due to dependency on other memory pool transactions
+ // because we're already processing them in order of dependency
+ map<uint256, CTxIndex> mapTestPoolTmp(mapTestPool);
git://git.novaco.in / electrum-server.git / commitdiff