Remove IRC support

Author: Neil Booth

contrib/raspberrypi3/install_electrumx.sh

@@ -17,7 +17,6 @@ sudo apt install libreadline6-dev/stable libreadline6/stable
 sudo apt-get install libleveldb-dev
 sudo apt-get install git
 sudo pip3 install plyvel
-sudo pip3 install irc
 
 # install electrumx
 git clone https://github.com/kyuupichan/electrumx.git

contrib/raspberrypi3/run_electrumx.sh

@@ -20,8 +20,6 @@ export TCP_PORT=50001
 export SSL_PORT=50002
 
 # visibility
-export IRC=
-export IRC_NICK=hostname
 export REPORT_HOST=hostname.com
 export RPC_PORT=8000
 

docs/ARCHITECTURE.rst

@@ -81,8 +81,3 @@ Database
 
 The underlying data store, made up of the DB backend (such as
 `leveldb`) and the host filesystem.
-
-IRC
----
-
-Handles advertising of ElectrumX services via IRC.

docs/ENVIRONMENT.rst

@@ -296,9 +296,7 @@ some of this.
   By default peer discovery happens over the clear internet.  Set this
   to non-empty to force peer discovery to be done via the proxy.  This
   might be useful if you are running a Tor service exclusively and
-  wish to keep your IP address private.  **NOTE**: in such a case you
-  should leave **IRC** unset as IRC connections are *always* over the
-  normal internet.
+  wish to keep your IP address private.
 
 * **TOR_PROXY_HOST**
 
@@ -317,8 +315,8 @@ some of this.
 Server Advertising
 ------------------
 
-These environment variables affect how your server is advertised, both
-by peer discovery (if enabled) and IRC (if enabled).
+These environment variables affect how your server is advertised
+by peer discovery (if enabled).
 
 * **REPORT_HOST**
 
@@ -357,27 +355,6 @@ by peer discovery (if enabled) and IRC (if enabled).
   self-signed.
 
 
-IRC
----
-
-Use the following environment variables if you want to advertise
-connectivity on IRC:
-
-* **IRC**
-
-  Set to anything non-empty to advertise on IRC.  ElectrumX connects
-  to IRC over the clear internet, always.
-
-* **IRC_NICK**
-
-  The nick to use when connecting to IRC.  The default is a hash of
-  **REPORT_HOST**.  Either way a prefix will be prepended depending on
-  **COIN** and **NET**.
-
-  If **REPORT_HOST_TOR** is set, an additional connection to IRC
-  happens with '_tor' appended to **IRC_NICK**.
-
-
 Cache
 -----
 

docs/HOWTO.rst

@@ -18,10 +18,6 @@ Python3          ElectrumX uses asyncio.  Python version >= 3.6 is
 DB Engine        I use `plyvel`_ 0.9, a Python interface to LevelDB.
                  A database engine package is required but others
                  are supported (see **Database Engine** below).
-`IRC`_           Python IRC package.  Only required if you enable
-                 IRC; ElectrumX will happily serve clients that
-                 try to connect directly.  I use 15.0.4 but
-                 older versions likely are fine.
 `x11_hash`_      Only required for DASH.  Python X11 Hash package.  Only
                  required if for Dash.  Version 1.4 tested.
 ================ ========================
@@ -414,7 +410,6 @@ You can then set the port as follows and advertise the service externally on the
 .. _`runit`: http://smarden.org/runit/index.html
 .. _`aiohttp`: https://pypi.python.org/pypi/aiohttp
 .. _`pylru`: https://pypi.python.org/pypi/pylru
-.. _`IRC`: https://pypi.python.org/pypi/irc
 .. _`x11_hash`: https://pypi.python.org/pypi/x11_hash
 .. _`contrib/python3.6/python-3.6.sh`: https://github.com/kyuupichan/electrumx/blob/master/contrib/python3.6/python-3.6.sh
 .. _`contrib/raspberrypi3/install_electrumx.sh`: https://github.com/kyuupichan/electrumx/blob/master/contrib/raspberrypi3/install_electrumx.sh

docs/PEER_DISCOVERY.rst

@@ -1,11 +1,8 @@
 Peer Discovery
 ==============
 
-This is a suggestion of a peer discovery prtocol as a way to gradually
-move off depending on IRC.
-
-It will be implemented in ElectrumX from version 0.11.0
-onwards.
+This was imlpemented in ElectrumX as of version 0.11.0.  Support for
+IRC peer discovery was removed in ElectrumX version 1.2.1.
 
 
 Peer Database
@@ -154,14 +151,12 @@ Unknown keys should be silently ignored.
 * **protocol_min**
 
   Strings that are the minimum and maximum Electrum protocol versions
-  this server speaks.  The maximum value should be the same as what
-  would suffix the letter **v** in the IRC real name.  Example: "1.1".
+  this server speaks.  Example: "1.1".
 
 * **pruning**
 
   An integer, the pruning limit.  Omit or set to *null* if there is no
-  pruning limit.  Should be the same as what would suffix the letter
-  **p** in the IRC real name.
+  pruning limit.
 
 
 server.add_peer RPC call
@@ -184,18 +179,6 @@ calls to this method from a single connection.
 The result should be True if accepted and False otherwise.
 
 
-IRC
----
-
-Other server implementations may not have implemented the peer
-discovery protocol yet.  Whilst we transition away from IRC, in order
-to keep these servers in the connected peer set, having one or two in
-the hard-coded peer list used to seed this process should suffice.
-Any peer on IRC will report other peers on IRC, and so if any one of
-them is known to any single peer implementing this protocol, they will
-all become known to all peers quite rapidly.
-
-
 Notes to Implementators
 -----------------------
 

docs/PROTOCOL.rst

@@ -846,8 +846,7 @@ Get a list of features and services supported by the server.
 * **protocol_min**
 
   Strings that are the minimum and maximum Electrum protocol versions
-  this server speaks.  The maximum value should be the same as what
-  would suffix the letter **v** in the IRC real name.  Example: "1.1".
+  this server speaks.  Example: "1.1".
 
 * **pruning**
 

docs/RPC-INTERFACE.rst

@@ -38,7 +38,7 @@ The following commands are available:
          "groups": 2,               # The number of session groups
          "logged": 0,               # The number of sessions being logged
          "paused": 0,               # The number of paused sessions.
-         "peers": 62,               # Number of peer servers (from IRC)
+         "peers": 62,               # Number of peer servers
          "pid": 126275,             # The server's process ID
          "requests": 0,             # Number of unprocessed requests
          "sessions": 85,            # Number of current sessions (connections)
@@ -153,14 +153,14 @@ The following commands are available:
 
   Returns a list of peer electrum servers.  This command takes no arguments.
 
-  Currently peer data is obtained via a peer discovery protocol; it
-  used to be taken from IRC.
+  Peer data is obtained via a peer discovery protocol documented in
+  `docs/PEER_DISCOVERY.rst`_.
 
 * **add_peer**
 
   Add a peer to the peers list.  ElectrumX will schdule an immediate
   connection attempt.  This command takes a single argument: the
-  peer's "real name" as it would advertise itself on IRC.
+  peer's "real name" as it used to advertise itself on IRC.
 
   .. code::
 
@@ -186,3 +186,5 @@ The following commands are available:
 
   Force a block chain reorg.  This command takes an optional
   argument - the number of blocks to reorg - which defaults to 3.
+
+.. _docs/PEER_DISCOVERY.rst: https://github.com/kyuupichan/electrumx/blob/master/docs/PEER_DISCOVERY.rst

lib/coins.py

@@ -70,9 +70,6 @@ class Coin(object):
     BLOCK_PROCESSOR = BlockProcessor
     XPUB_VERBYTES = bytes('????', 'utf-8')
     XPRV_VERBYTES = bytes('????', 'utf-8')
-    IRC_PREFIX = None
-    IRC_SERVER = "irc.freenode.net"
-    IRC_PORT = 6667
     # Peer discovery
     PEER_DEFAULT_PORTS = {'t': '50001', 's': '50002'}
     PEERS = []
@@ -87,8 +84,6 @@ def lookup_coin_class(cls, name, net):
             if (coin.NAME.lower() == name.lower() and
                     coin.NET.lower() == net.lower()):
                 coin_req_attrs = req_attrs.copy()
-                if coin.IRC_PREFIX is not None:
-                    coin_req_attrs.append('IRC_CHANNEL')
                 missing = [attr for attr in coin_req_attrs
                            if not hasattr(coin, attr)]
                 if missing:
@@ -616,8 +611,6 @@ class Viacoin(AuxPowMixin, Coin):
     TX_COUNT = 113638
     TX_COUNT_HEIGHT = 3473674
     TX_PER_BLOCK = 30
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL="#vialectrum"
     RPC_PORT = 5222
     REORG_LIMIT = 5000
     DESERIALIZER = lib_tx.DeserializerAuxPowSegWit
@@ -665,8 +658,9 @@ class Namecoin(AuxPowMixin, Coin):
     TX_COUNT = 4415768
     TX_COUNT_HEIGHT = 329065
     TX_PER_BLOCK = 10
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#electrum-nmc"
+    PEERS = [
+        'elec.luggs.co s446',
+    ]
 
 
 class NamecoinTestnet(Namecoin):
@@ -694,8 +688,6 @@ class Dogecoin(AuxPowMixin, Coin):
     TX_COUNT = 27583427
     TX_COUNT_HEIGHT = 1604979
     TX_PER_BLOCK = 20
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#electrum-doge"
     REORG_LIMIT = 2000
 
 
@@ -726,8 +718,6 @@ class Dash(Coin):
     TX_COUNT = 2157510
     TX_PER_BLOCK = 4
     RPC_PORT = 9998
-    IRC_PREFIX = "D_"
-    IRC_CHANNEL = "#electrum-dash"
     PEERS = [
         'electrum.dash.org s t',
         'electrum.masternode.io s t',
@@ -760,7 +750,6 @@ class DashTestnet(Dash):
     TX_COUNT = 132681
     TX_PER_BLOCK = 1
     RPC_PORT = 19998
-    IRC_PREFIX = "d_"
     PEER_DEFAULT_PORTS = {'t': '51001', 's': '51002'}
     PEERS = [
         'electrum.dash.siampm.com s t',
@@ -779,8 +768,6 @@ class Argentum(AuxPowMixin, Coin):
     TX_COUNT = 2263089
     TX_COUNT_HEIGHT = 2050260
     TX_PER_BLOCK = 2000
-    IRC_PREFIX = "A_"
-    IRC_CHANNEL = "#electrum-arg"
     RPC_PORT = 13581
 
 
@@ -806,8 +793,6 @@ class DigiByte(Coin):
     TX_COUNT = 1046018
     TX_COUNT_HEIGHT = 1435000
     TX_PER_BLOCK = 1000
-    IRC_PREFIX = "DE_"
-    IRC_CHANNEL = "#electrum-dgb"
     RPC_PORT = 12022
 
 
@@ -818,8 +803,6 @@ class DigiByteTestnet(DigiByte):
     WIF_BYTE = bytes.fromhex("ef")
     GENESIS_HASH = ('b5dca8039e300198e5fe7cd23bdd1728'
                     'e2a444af34c447dbd0916fa3430a68c2')
-    IRC_PREFIX = "DET_"
-    IRC_CHANNEL = "#electrum-dgb"
     RPC_PORT = 15022
     REORG_LIMIT = 2000
 
@@ -837,8 +820,6 @@ class FairCoin(Coin):
     TX_COUNT = 505
     TX_COUNT_HEIGHT = 470
     TX_PER_BLOCK = 1
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#fairlectrum"
     RPC_PORT = 40405
     PEER_DEFAULT_PORTS = {'t': '51811', 's': '51812'}
     PEERS = [
@@ -882,8 +863,6 @@ class Zcash(EquihashMixin, Coin):
     TX_COUNT = 329196
     TX_COUNT_HEIGHT = 68379
     TX_PER_BLOCK = 5
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#electrum-zcash"
     RPC_PORT = 8232
     REORG_LIMIT = 800
 
@@ -939,8 +918,6 @@ class Einsteinium(Coin):
     TX_COUNT = 2087559
     TX_COUNT_HEIGHT = 1358517
     TX_PER_BLOCK = 2
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#electrum-emc2"
     RPC_PORT = 41879
     REORG_LIMIT = 2000
 
@@ -958,8 +935,6 @@ class Blackcoin(ScryptMixin, Coin):
     TX_COUNT = 4594999
     TX_COUNT_HEIGHT = 1667070
     TX_PER_BLOCK = 3
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#electrum-blk"
     RPC_PORT = 15715
     REORG_LIMIT = 5000
 
@@ -977,8 +952,6 @@ class Bitbay(ScryptMixin, Coin):
     TX_COUNT = 4594999
     TX_COUNT_HEIGHT = 1667070
     TX_PER_BLOCK = 3
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#electrum-bay"
     RPC_PORT = 19914
     REORG_LIMIT = 5000
 
@@ -997,8 +970,6 @@ class Peercoin(Coin):
     TX_COUNT = 1207356
     TX_COUNT_HEIGHT = 306425
     TX_PER_BLOCK = 4
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#electrum-ppc"
     RPC_PORT = 9902
     REORG_LIMIT = 5000
 
@@ -1016,8 +987,6 @@ class Reddcoin(Coin):
     TX_COUNT = 5413508
     TX_COUNT_HEIGHT = 1717382
     TX_PER_BLOCK = 3
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL = "#electrum-rdd"
     RPC_PORT = 45443
 
 
@@ -1197,8 +1166,6 @@ class CanadaeCoin(AuxPowMixin, Coin):
     TX_COUNT = 3455905
     TX_COUNT_HEIGHT = 3645419
     TX_PER_BLOCK = 1
-    IRC_PREFIX = "E_"
-    IRC_CHANNEL="#electrum-cdn"
     RPC_PORT = 34330
     REORG_LIMIT = 1000
 

server/env.py

@@ -68,10 +68,6 @@ def __init__(self):
         self.bandwidth_limit = self.integer('BANDWIDTH_LIMIT', 2000000)
         self.session_timeout = self.integer('SESSION_TIMEOUT', 600)
 
-        # IRC
-        self.irc = self.boolean('IRC', False)
-        self.irc_nick = self.default('IRC_NICK', None)
-
         # Identities
         clearnet_identity = self.clearnet_identity()
         tor_identity = self.tor_identity(clearnet_identity)
@@ -104,7 +100,7 @@ def clearnet_identity(self):
                    or host.lower() == 'localhost')
         else:
             bad = (ip.is_multicast or ip.is_unspecified
-                   or (ip.is_private and (self.irc or self.peer_announce)))
+                   or (ip.is_private and self.peer_announce))
         if bad:
             raise self.Error('"{}" is not a valid REPORT_HOST'.format(host))
         tcp_port = self.integer('REPORT_TCP_PORT', self.tcp_port) or None