[order_utils.py] is_signature_valid, via Exchange contract (#1216)

First support for signature validation, done via Exchange contract's
isValidSignature() method.

2 files changed, 141 insertions, 19 deletions

diff --git a/python-packages/order_utils/test/test_doctest.py b/python-packages/order_utils/test/test_doctest.py
index ba5da5418..2b0350ac0 100644
--- a/python-packages/order_utils/test/test_doctest.py
+++ b/python-packages/order_utils/test/test_doctest.py
@@ -1,24 +1,18 @@
-"""Exercise doctests for order_utils module."""
+"""Exercise doctests for all of our modules."""
 
 from doctest import testmod
+import pkgutil
 
-from zero_ex.dev_utils import abi_utils, type_assertions
-from zero_ex.order_utils import asset_data_utils
+import zero_ex
 
 
-def test_doctest_asset_data_utils():
-    """Invoke doctest on the asset_data_utils module."""
-    (failure_count, _) = testmod(asset_data_utils)
-    assert failure_count == 0
-
-
-def test_doctest_abi_utils():
-    """Invoke doctest on the abi_utils module."""
-    (failure_count, _) = testmod(abi_utils)
-    assert failure_count == 0
-
-
-def test_doctest_type_assertions():
-    """Invoke doctest on the type_assertions module."""
-    (failure_count, _) = testmod(type_assertions)
-    assert failure_count == 0
+def test_all_doctests():
+    """Gather zero_ex.* modules and doctest them."""
+    # prefer `black` formatting. pylint: disable=bad-continuation
+    for (importer, modname, _) in pkgutil.walk_packages(
+        path=zero_ex.__path__, prefix="zero_ex."
+    ):
+        module = importer.find_module(modname).load_module(modname)
+        print(module)
+        (failure_count, _) = testmod(module)
+        assert failure_count == 0
diff --git a/python-packages/order_utils/test/test_signature_utils.py b/python-packages/order_utils/test/test_signature_utils.py
new file mode 100644
index 000000000..b688e03a1
--- /dev/null
+++ b/python-packages/order_utils/test/test_signature_utils.py
@@ -0,0 +1,128 @@
+"""Tests of zero_ex.order_utils.signature_utils."""
+
+import pytest
+from web3 import Web3
+
+from zero_ex.order_utils.signature_utils import is_valid_signature
+
+
+def test_is_valid_signature__provider_wrong_type():
+    """Test that giving a non-HTTPProvider raises a TypeError."""
+    with pytest.raises(TypeError):
+        is_valid_signature(
+            123,
+            "0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b"
+            + "0",
+            "0x1B61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351b"
+            + "c3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace"
+            + "225403",
+            "0x5409ed021d9299bf6814279a6a1411a7e866a631",
+        )
+
+
+def test_is_valid_signature__data_not_string():
+    """Test that giving non-string `data` raises a TypeError."""
+    with pytest.raises(TypeError):
+        is_valid_signature(
+            Web3.HTTPProvider("http://127.0.0.1:8545"),
+            123,
+            "0x1B61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351b"
+            + "c3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace"
+            + "225403",
+            "0x5409ed021d9299bf6814279a6a1411a7e866a631",
+        )
+
+
+def test_is_valid_signature__data_not_hex_string():
+    """Test that giving non-hex-string `data` raises a ValueError."""
+    with pytest.raises(ValueError):
+        is_valid_signature(
+            Web3.HTTPProvider("http://127.0.0.1:8545"),
+            "jjj",
+            "0x1B61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351b"
+            + "c3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace"
+            + "225403",
+            "0x5409ed021d9299bf6814279a6a1411a7e866a631",
+        )
+
+
+def test_is_valid_signature__signature_not_string():
+    """Test that passng a non-string signature raises a TypeError."""
+    with pytest.raises(TypeError):
+        is_valid_signature(
+            Web3.HTTPProvider("http://127.0.0.1:8545"),
+            "0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b"
+            + "0",
+            123,
+            "0x5409ed021d9299bf6814279a6a1411a7e866a631",
+        )
+
+
+def test_is_valid_signature__signature_not_hex_string():
+    """Test that passing a non-hex-string signature raises a ValueError."""
+    with pytest.raises(ValueError):
+        is_valid_signature(
+            Web3.HTTPProvider("http://127.0.0.1:8545"),
+            "0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b"
+            + "0",
+            "jjj",
+            "0x5409ed021d9299bf6814279a6a1411a7e866a631",
+        )
+
+
+def test_is_valid_signature__signer_address_not_string():
+    """Test that giving a non-address `signer_address` raises a ValueError."""
+    with pytest.raises(TypeError):
+        is_valid_signature(
+            Web3.HTTPProvider("http://127.0.0.1:8545"),
+            "0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b"
+            + "0",
+            "0x1B61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351b"
+            + "c3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace"
+            + "225403",
+            123,
+        )
+
+
+def test_is_valid_signature__signer_address_not_hex_string():
+    """Test that giving a non-hex-str `signer_address` raises a ValueError."""
+    with pytest.raises(ValueError):
+        is_valid_signature(
+            Web3.HTTPProvider("http://127.0.0.1:8545"),
+            "0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b"
+            + "0",
+            "0x1B61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351b"
+            + "c3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace"
+            + "225403",
+            "jjj",
+        )
+
+
+def test_is_valid_signature__signer_address_not_valid_address():
+    """Test that giving a non-address for `signer_address` raises an error."""
+    with pytest.raises(ValueError):
+        is_valid_signature(
+            Web3.HTTPProvider("http://127.0.0.1:8545"),
+            "0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b"
+            + "0",
+            "0x1B61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351b"
+            + "c3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace"
+            + "225403",
+            "0xff",
+        )
+
+
+def test_is_valid_signature__unsupported_sig_types():
+    """Test that passing in a sig w/invalid type raises error.
+
+    To induce this error, the last byte of the signature is tweaked from 03 to
+    ff."""
+    (is_valid, reason) = is_valid_signature(
+        Web3.HTTPProvider("http://127.0.0.1:8545"),
+        "0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b0",
+        "0x1B61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351bc334"
+        + "0349190569279751135161d22529dc25add4f6069af05be04cacbda2ace2254ff",
+        "0x5409ed021d9299bf6814279a6a1411a7e866a631",
+    )
+    assert is_valid is False
+    assert reason == "SIGNATURE_UNSUPPORTED"