Merge pull request #1008 from rayrapetyan/master

 FreeBSD initial support

Author: carver

README.md

@@ -81,6 +81,7 @@ Please see OS-specific instructions for:
 - [Linux](docs/README-linux.md#Developer-Setup)
 - [Mac](docs/README-osx.md#Developer-Setup)
 - [Windows](docs/README-windows.md#Developer-Setup)
+- [FreeBSD](docs/README-freebsd.md#Developer-Setup)
 
 Then run these install commands:
 

docs/README-freebsd.md

@@ -0,0 +1,50 @@
+# Web3.py on FreeBSD (11.2)
+
+## Developer Setup
+
+### Prerequisites
+
+Make sure you've UTF-8 defined for charset and lang in your [~/.login_conf](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/using-localization.html), 
+otherwise almost every module will fail to install. Python 3 is very sensitive to that.
+
+```
+sudo pkg install python3 py36-virtualenv leveldb libxml2 libxslt pkgconf secp256k1 wget git
+sudo wget https://raw.githubusercontent.com/bitcoin/bitcoin/master/src/secp256k1/include/secp256k1_recovery.h -O /usr/local/include/secp256k1_recovery.h
+echo '#include "/usr/include/stdlib.h"' | sudo tee -a /usr/include/alloca.h > /dev/null
+mkdir -p /tmp/venv_python
+virtualenv-3.6 /tmp/venv_python/python3
+source /tmp/venv_python/python3/bin/activate.csh
+
+# these two modules fail to install natively
+pip install ptyprocess eth-account
+
+cd /tmp
+git clone https://github.com/ethereum/web3.py.git
+cd web3.py
+pip install -e .\[tester\] -r requirements-dev.txt --global-option=build_ext --global-option='-I/usr/local/include'
+```
+
+## Test
+
+#### Prerequisites for integration tests:
+
+##### geth (https://github.com/ethereum/go-ethereum/wiki/Installation-Instructions-for-FreeBSD)
+```
+pkg install go
+cd /tmp
+git clone https://github.com/ethereum/go-ethereum
+cd go-ethereum
+make geth
+cp build/bin/geth /usr/local/bin/
+```
+
+##### parity (https://github.com/paukstis/freebsd_parity/blob/v1.6/README.md)
+```
+BROKEN (build crashes on FreeBSD 11.2)
+```
+
+```
+py.test tests/core
+py.test tests/ens
+py.test tests/integration
+```

docs/providers.rst

@@ -246,7 +246,7 @@ IPCProvider
     If no ``ipc_path`` is specified, it will use the first IPC file
     it can find from this list:
 
-    - On Linux:
+    - On Linux and FreeBSD:
 
       - ``~/.ethereum/geth.ipc``
       - ``~/.local/share/io.parity.ethereum/jsonrpc.ipc``

web3/providers/ipc.py

@@ -91,7 +91,7 @@ def get_default_ipc_path(testnet=False):
         if os.path.exists(ipc_path):
             return ipc_path
 
-    elif sys.platform.startswith('linux'):
+    elif sys.platform.startswith('linux') or sys.platform.startswith('freebsd'):
         ipc_path = os.path.expanduser(os.path.join(
             "~",
             ".ethereum",
@@ -132,7 +132,7 @@ def get_default_ipc_path(testnet=False):
 
     else:
         raise ValueError(
-            "Unsupported platform '{0}'.  Only darwin/linux2/win32 are "
+            "Unsupported platform '{0}'.  Only darwin/linux/win32/freebsd are "
             "supported.  You must specify the ipc_path".format(sys.platform)
         )
 
@@ -147,7 +147,7 @@ def get_dev_ipc_path():
         if os.path.exists(ipc_path):
             return ipc_path
 
-    elif sys.platform.startswith('linux'):
+    elif sys.platform.startswith('linux') or sys.platform.startswith('freebsd'):
         ipc_path = os.path.expanduser(os.path.join(
             "/tmp",
             "geth.ipc"
@@ -176,7 +176,7 @@ def get_dev_ipc_path():
 
     else:
         raise ValueError(
-            "Unsupported platform '{0}'.  Only darwin/linux2/win32 are "
+            "Unsupported platform '{0}'.  Only darwin/linux/win32/freebsd are "
             "supported.  You must specify the ipc_path".format(sys.platform)
         )