Live test fixes (#260)

saschagoebel · web-flow · commit fb1bfa3a890b · 2019-07-26T09:08:48.000+02:00
* Add missing gas price parameter * Make loglevel configurable via environment * Config file is optional, because the application can be configured via Environment as well. * Improve parameter validation & implicitly typecast int and float values. Invalid values will throw a ValueError anyway. * Make RPC timeouts configurable * Sort config keys * Update Example Config with Ropsten Test Values * Formatting * Fix tests * Fix float check & change poll interval to int * Make event fetcher a bit more verbose on info level * Update Test-Token Address * Use Checksummed address * Add missing library versions to constraints.txt * Rename token_contract_address to foreign_chain_token_contract_address * Fix Nonce Calculation, GasPrice & ChainId * Cleanup pre-commit, so that just python3 is required * Fix tests, but this will likely not work in production (chainId) * Update example to reflect new config parameter name for token bridge * Formatting * Upgrade web3 from 5.0.0b2 to 5.0.0b4 (#263) ethpm has been integrated into web3. That means we can get rid of the workaround for missing dependencies. Before upgrading to this version, the standalone ethpm package has to be manually uninstalled. The following PR has been merged into 5.0.0b4, which is the primary reason for the upgrade: ethereum/web3.py#1378
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,3 +1,6 @@
+default_language_version:
+    python: python3
+
 repos:
 - repo: https://github.com/trustlines-protocol/more-pre-commit-hooks.git
   rev: 1edc6d3ab9380e17eb01a601551283cf7bc23f2b
@@ -17,25 +20,21 @@ repos:
     rev: 19.3b0
     hooks:
     - id: black
-      language_version: python3.6
 
 -   repo: git://github.com/pre-commit/pre-commit-hooks
     rev: v2.2.3
     hooks:
     - id: check-added-large-files
     - id: check-ast
-      language_version: python3.6
     - id: check-byte-order-marker
     - id: check-case-conflict
     - id: check-json
     - id: check-merge-conflict
     - id: check-yaml
     - id: debug-statements
-      language_version: python3.6
     - id: end-of-file-fixer
       exclude: ^contracts/contracts/lib/.*\.sol|contracts/contracts/token/TrustlinesNetworkToken.sol$
     - id: flake8
-      language_version: python3.6
       additional_dependencies: ["flake8-string-format", "flake8-per-file-ignores"]
     - id: trailing-whitespace
       exclude: ^contracts/contracts/lib/.*\.sol$
diff --git a/constraints.txt b/constraints.txt
@@ -14,6 +14,7 @@ Click==7.0
 contract-deploy-tools==0.4.3
 cryptography==2.7
 cytoolz==0.9.0.1
+decorator==4.4.0
 entrypoints==0.3
 eth-abi==2.0.0b9
 eth-account==0.4.0
@@ -25,7 +26,6 @@ eth-rlp==0.1.2
 eth-tester==0.1.0b39
 eth-typing==2.1.0
 eth-utils==1.6.0
-ethpm==0.1.4a19
 flake8==3.7.7
 flake8-polyfill==1.0.2
 gevent==1.4.0
@@ -57,7 +57,6 @@ protobuf==3.8.0
 py==1.8.0
 py-ecc==1.7.0
 py-evm==0.2.0a42
-py-geth==2.1.0
 py-solc==3.2.0
 pycodestyle==2.5.0
 pycparser==2.19
@@ -67,8 +66,8 @@ pyflakes==2.1.1
 pyparsing==2.4.0
 pysha3==1.0.2
 pytest==4.6.2
-pytest-ethereum==0.1.3a6
 python-dateutil==2.8.0
+python-dotenv==0.10.3
 pytzdata==2019.1
 PyYAML==5.1
 requests==2.22.0
@@ -82,10 +81,11 @@ toolz==0.9.0
 trie==1.4.0
 typed-ast==1.3.5
 urllib3==1.25.3
+validators==0.13.0
 varint==1.0.2
 virtualenv==16.6.0
 wcwidth==0.1.7
-web3==5.0.0b2
+web3==5.0.0b4
 websockets==7.0
 wheel==0.33.4
 zipp==0.5.1
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -5,12 +5,3 @@ pep8-naming
 pre-commit
 pytest
 setuptools_scm
-
-# The following three dependencies are missing because ethpm has a
-# dependency on web3[tester]. This is a hacky workaround. For details
-# visit:
-# https://github.com/trustlines-protocol/contract-deploy-tools/pull/38#issuecomment-499412276
-
-py-geth
-eth-tester[py-evm]
-pytest-ethereum
diff --git a/tools/bridge/.env.example b/tools/bridge/.env.example
@@ -1,11 +1,22 @@
 # The Home RPC Address. Should point to a Trustlines RPC Node
-HOME_RPC_URL=http://node_home:8545
+HOME_RPC_URL=http://localhost:8545
 
 # The Foreign RPC Address. Should point to a Mainnet / Ropsten RPC Node
-FOREIGN_RPC_URL=http://node_foreign:8545
+FOREIGN_RPC_URL=http://parity.ropsten.ethnodes.brainbot.com:8545
 
 # The Address of the Token Contract on the Foreign Network
-TOKEN_CONTRACT_ADDRESS=0x20fE562d797A42Dcb3399062AE9546cd06f63280
+FOREIGN_CHAIN_TOKEN_CONTRACT_ADDRESS=0xCd7464985f3b5dbD96e12da9b018BA45a64256E6
 
 # The Address of the Bridge Contract on the Foreign Network
-FOREIGN_BRIDGE_CONTRACT_ADDRESS=0x83a30dD54a744c60190548af8d983719116eff4a
+FOREIGN_BRIDGE_CONTRACT_ADDRESS=0x8d25a6C7685ca80fF110b2B3CEDbcd520FdE8Dd3
+
+# The Deployment Block Number of the Bridge Contract on the Foreign Network
+FOREIGN_CHAIN_EVENT_FETCH_START_BLOCK_NUMBER=6057718
+
+# The Address of the Bridge Contract on the Home Network
+HOME_BRIDGE_CONTRACT_ADDRESS=0x321b427210E706747129cfF9BC6A33607Ed86dff
+
+# The Deployment Block Number of the Bridge Contract on the Home Network
+HOME_CHAIN_EVENT_FETCH_START_BLOCK_NUMBER=3395992
+
+VALIDATOR_PRIVATE_KEY=
diff --git a/tools/bridge/bridge/config.py b/tools/bridge/bridge/config.py
@@ -13,6 +13,8 @@
 )
 from eth_utils.toolz import merge
 
+import validators
+
 from eth_keys.constants import SECPK1_N
 
 from dotenv import load_dotenv
@@ -21,25 +23,29 @@
 
 
 def validate_rpc_url(url: Any) -> str:
-    if not isinstance(url, str):
+    if not validators.url(url):
         raise ValueError(f"{url} is not a valid RPC url")
     return url
 
 
-def validate_non_negative_integer(number: Any) -> float:
+def validate_non_negative_integer(number: Any) -> int:
+    if str(number) != str(int(number)):
+        raise ValueError(f"{number} is not a valid integer")
     if not isinstance(number, int):
-        raise ValueError(f"{number} is not an integer")
+        number = int(number)
     if number < 0:
         raise ValueError(f"{number} must be greater than or equal zero")
-    return int(number)
+    return number
 
 
 def validate_positive_float(number: Any) -> float:
-    if not isinstance(number, (int, float)):
-        raise ValueError(f"{number} is neither integer nor float")
+    if str(number) != str(float(number)) and str(number) != str(int(number)):
+        raise ValueError(f"{number} is not a valid float")
+    if not isinstance(number, float):
+        number = float(number)
     if number <= 0:
         raise ValueError(f"{number} must be positive")
-    return float(number)
+    return number
 
 
 def validate_checksum_address(address: Any) -> bytes:
@@ -67,32 +73,38 @@ def validate_private_key(private_key: Any) -> bytes:
 
 REQUIRED_CONFIG_ENTRIES = [
     "home_rpc_url",
-    "foreign_rpc_url",
-    "token_contract_address",
     "home_bridge_contract_address",
+    "foreign_rpc_url",
+    "foreign_chain_token_contract_address",
     "foreign_bridge_contract_address",
     "validator_private_key",
 ]
 
 OPTIONAL_CONFIG_ENTRIES_WITH_DEFAULTS: Dict[str, Any] = {
+    "home_rpc_timeout": 180,
+    "home_chain_gas_price": 10 * 1000000000,  # Gas price is in GWei
     "home_chain_max_reorg_depth": 1,
+    "home_chain_event_fetch_start_block_number": 0,
+    "foreign_rpc_timeout": 180,
     "foreign_chain_max_reorg_depth": 10,
     "foreign_chain_event_poll_interval": 5,
     "foreign_chain_event_fetch_start_block_number": 0,
-    "home_chain_event_fetch_start_block_number": 0,
 }
 
 CONFIG_ENTRY_VALIDATORS = {
     "home_rpc_url": validate_rpc_url,
-    "foreign_rpc_url": validate_rpc_url,
-    "token_contract_address": validate_checksum_address,
-    "home_bridge_contract_address": validate_checksum_address,
-    "foreign_bridge_contract_address": validate_checksum_address,
+    "home_rpc_timeout": validate_non_negative_integer,
+    "home_chain_gas_price": validate_non_negative_integer,
     "home_chain_max_reorg_depth": validate_non_negative_integer,
+    "home_bridge_contract_address": validate_checksum_address,
+    "home_chain_event_fetch_start_block_number": validate_non_negative_integer,
+    "foreign_rpc_url": validate_rpc_url,
+    "foreign_rpc_timeout": validate_non_negative_integer,
     "foreign_chain_max_reorg_depth": validate_non_negative_integer,
-    "foreign_chain_event_poll_interval": validate_positive_float,
+    "foreign_chain_event_poll_interval": validate_non_negative_integer,
+    "foreign_chain_token_contract_address": validate_checksum_address,
+    "foreign_bridge_contract_address": validate_checksum_address,
     "foreign_chain_event_fetch_start_block_number": validate_non_negative_integer,
-    "home_chain_event_fetch_start_block_number": validate_non_negative_integer,
     "validator_private_key": validate_private_key,
 }
 
diff --git a/tools/bridge/bridge/confirmation_sender.py b/tools/bridge/bridge/confirmation_sender.py
@@ -36,7 +36,7 @@ def __init__(
         self.pending_transaction_queue: Queue[Dict[str, Any]] = Queue()
 
     def get_next_nonce(self):
-        return self.w3.eth.getTransactionCount(self.address)
+        return self.w3.eth.getTransactionCount(self.address, "pending")
 
     def run(self):
         self.logger.info("Starting")
@@ -58,12 +58,24 @@ def send_confirmation_transactions(self):
 
     def prepare_confirmation_transaction(self, transfer_event):
         nonce = self.get_next_nonce()
+        self.logger.debug(
+            f"Preparing confirmation transaction for address "
+            f"{transfer_event.args['from']} for {transfer_event.args.value} "
+            f"coins (nonce {nonce}, chain {self.w3.eth.chainId})"
+        )
         transaction = self.home_bridge_contract.functions.confirmTransfer(
             self.compute_transfer_hash(transfer_event),
             transfer_event.transactionHash,
             transfer_event.args.value,
             transfer_event.args["from"],
-        ).buildTransaction({"gasPrice": self.gas_price, "nonce": nonce})
+        ).buildTransaction(
+            {
+                "gasPrice": self.gas_price,
+                "nonce": nonce,
+                # "gas": 1000000,
+                # "chainId": self.w3.eth.chainId,  # TODO: This should be obsolete with web3 5.0.0b4
+            }
+        )
         signed_transaction = self.w3.eth.account.sign_transaction(
             transaction, self.private_key
         )
@@ -77,9 +89,10 @@ def compute_transfer_hash(self, transfer):
         )
 
     def send_confirmation_transaction(self, transaction):
-        self.logger.info(f"Sending confirmation transaction {transaction}")
         self.pending_transaction_queue.put(transaction)
-        self.w3.eth.sendRawTransaction(transaction.rawTransaction)
+        tx_hash = self.w3.eth.sendRawTransaction(transaction.rawTransaction)
+        self.logger.info(f"Sent confirmation transaction {tx_hash.hex()}")
+        return tx_hash
 
     def watch_pending_transactions(self):
         while True:
@@ -95,7 +108,7 @@ def clear_confirmed_transactions(self):
             receipt = self.w3.eth.getTransactionReceipt(oldest_pending_transaction.hash)
             if receipt and receipt.blockNumber <= confirmation_threshold:
                 self.logger.info(
-                    f"Transaction has been confirmed: {oldest_pending_transaction}"
+                    f"Transaction has been confirmed: {oldest_pending_transaction.hash.hex()}"
                 )
                 confirmed_transaction = (
                     self.pending_transaction_queue.get()
diff --git a/tools/bridge/bridge/event_fetcher.py b/tools/bridge/bridge/event_fetcher.py
@@ -84,7 +84,10 @@ def fetch_events_in_range(
             argument_filters=self.event_argument_filter,
         )
 
-        self.logger.debug(f"Found {len(events)} events.")
+        if len(events) > 0:
+            self.logger.info(f"Found {len(events)} events.")
+        else:
+            self.logger.debug(f"Found {len(events)} events.")
 
         for event in events:
             self.event_queue.put(event)
diff --git a/tools/bridge/bridge/main.py b/tools/bridge/bridge/main.py
@@ -3,6 +3,7 @@
 monkey.patch_all()  # noqa: E402
 
 import logging
+import os
 
 import gevent
 from gevent import Greenlet
@@ -25,7 +26,7 @@
     "--config",
     "config_path",
     type=click.Path(exists=True),
-    required=True,
+    required=False,
     help="Path to a config file",
 )
 def main(config_path: str) -> None:
@@ -37,7 +38,9 @@ def main(config_path: str) -> None:
     See .env.example and config.py for valid configuration options and defaults.
     """
 
-    logging.basicConfig(level=logging.INFO)
+    logging.basicConfig(level=os.environ.get("LOGLEVEL", "INFO").upper())
+
+    logging.info("Starting Trustlines Bridge Validation Server")
 
     try:
         config = load_config(config_path)
@@ -46,8 +49,18 @@ def main(config_path: str) -> None:
     except ValueError as value_error:
         raise click.UsageError(f"Invalid config file: {value_error}") from value_error
 
-    w3_foreign = Web3(HTTPProvider(config["foreign_rpc_url"]))
-    w3_home = Web3(HTTPProvider(config["home_rpc_url"]))
+    w3_foreign = Web3(
+        HTTPProvider(
+            config["foreign_rpc_url"],
+            request_kwargs={"timeout": config["foreign_rpc_timeout"]},
+        )
+    )
+    w3_home = Web3(
+        HTTPProvider(
+            config["home_rpc_url"],
+            request_kwargs={"timeout": config["home_rpc_timeout"]},
+        )
+    )
 
     home_bridge_contract = w3_home.eth.contract(
         address=config["home_bridge_contract_address"], abi=HOME_BRIDGE_ABI
@@ -57,7 +70,7 @@ def main(config_path: str) -> None:
 
     transfer_event_fetcher = EventFetcher(
         web3=w3_foreign,
-        contract_address=config["token_contract_address"],
+        contract_address=config["foreign_chain_token_contract_address"],
         contract_abi=MINIMAL_ERC20_TOKEN_ABI,
         event_name="Transfer",
         event_argument_filter={"to": config["foreign_bridge_contract_address"]},
diff --git a/tools/bridge/requirements.txt b/tools/bridge/requirements.txt
@@ -5,4 +5,5 @@ toml
 web3
 contract-deploy-tools
 python-dotenv
+validators
 -r ../../requirements-dev.txt
diff --git a/tools/bridge/tests/test_config.py b/tools/bridge/tests/test_config.py
@@ -38,7 +38,7 @@ def test_validate_rpc_url():
 
 
 def test_validate_invalid_rpc_url():
-    with pytest.raises(ValueError):
+    with pytest.raises(TypeError):
         validate_rpc_url(1)
 
 
@@ -60,9 +60,13 @@ def test_validate_positive_float():
     validate_positive_float(1.1)
 
 
+def test_validate_positive_float_int():
+    validate_positive_float(5)
+
+
 def test_validate_positive_float_false_type():
     with pytest.raises(ValueError):
-        validate_positive_float("1.1")
+        validate_positive_float("foo")
 
 
 def test_validate_positive_float_negative():
