Merge pull request #12 from stakewise/ws-endpoint-timeout

Add setting to change WS endpoint timeout

Author: tsudmi

README.md

@@ -70,6 +70,7 @@ where `settings.txt` is an environment file with [Settings](#settings).
 |----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|
 | LOG_LEVEL                              | The log level of the program.                                                                                                                                                                           | No       | DEBUG   |
 | WEB3_WS_ENDPOINT                       | The WS endpoint to the ETH1 client. Must be specified if `WEB3_HTTP_ENDPOINT` endpoint is not provided.                                                                                                 | No       | -       |
+| WEB3_WS_ENDPOINT_TIMEOUT               | The WS endpoint timeout in seconds.                                                                                                                                                                     | No       | 60      |
 | WEB3_HTTP_ENDPOINT                     | The HTTP endpoint to the ETH1 client. Must be specified if `WEB3_WS_ENDPOINT` endpoint is not provided.                                                                                                 | No       | -       |
 | BEACON_CHAIN_RPC_ENDPOINT              | The Beacon Chain RPC HTTP endpoint.                                                                                                                                                                     | Yes      | -       |
 | INJECT_POA_MIDDLEWARE                  | Whether to inject POA middleware into Web3 client (see [POA middleware](https://web3py.readthedocs.io/en/stable/middleware.html#geth-style-proof-of-authority)).                                        | No       | False   |
@@ -104,7 +105,7 @@ BALANCE_WARNING_THRESHOLD=0.05
 BALANCE_ERROR_THRESHOLD=0.008
 APPLY_GAS_PRICE_STRATEGY=True
 MAX_TX_WAIT_SECONDS=180
-TRANSACTION_TIMEOUT=3600
+TRANSACTION_TIMEOUT=10800
 PROCESS_INTERVAL=30
 ORACLES_CONTRACT_ADDRESS=0x2f1C5E86B13a74f5A6E7B4b35DD77fe29Aa47514
 POOL_CONTRACT_ADDRESS=0xC874b064f465bdD6411D45734b56fac750Cda29A

main.py

@@ -7,6 +7,7 @@
 from src.reward_token import RewardToken
 from src.settings import (
     WEB3_WS_ENDPOINT,
+    WEB3_WS_ENDPOINT_TIMEOUT,
     WEB3_HTTP_ENDPOINT,
     INJECT_POA_MIDDLEWARE,
     INJECT_STALE_CHECK_MIDDLEWARE,
@@ -49,6 +50,7 @@ def main() -> None:
     web3_client = get_web3_client(
         http_endpoint=WEB3_HTTP_ENDPOINT,
         ws_endpoint=WEB3_WS_ENDPOINT,
+        ws_endpoint_timeout=WEB3_WS_ENDPOINT_TIMEOUT,
         apply_gas_price_strategy=APPLY_GAS_PRICE_STRATEGY,
         max_tx_wait_seconds=MAX_TX_WAIT_SECONDS,
         inject_retry_request=INJECT_RETRY_REQUEST_MIDDLEWARE,

src/settings.py

@@ -11,6 +11,7 @@
 # connections
 # use either WS or HTTP for Web3
 WEB3_WS_ENDPOINT: str = environ.get("WEB3_WS_ENDPOINT", "")
+WEB3_WS_ENDPOINT_TIMEOUT: int = int(environ.get("WEB3_WS_ENDPOINT_TIMEOUT", "60"))
 WEB3_HTTP_ENDPOINT: str = "" if WEB3_WS_ENDPOINT else environ["WEB3_HTTP_ENDPOINT"]
 BEACON_CHAIN_RPC_ENDPOINT: str = environ["BEACON_CHAIN_RPC_ENDPOINT"]
 

src/utils.py

@@ -78,6 +78,7 @@ def ws_retry_request_middleware(
 def get_web3_client(
     http_endpoint: str = "",
     ws_endpoint: str = "",
+    ws_endpoint_timeout: int = 60,
     apply_gas_price_strategy: bool = False,
     max_tx_wait_seconds: int = 120,
     inject_retry_request: bool = False,
@@ -89,7 +90,9 @@ def get_web3_client(
     """Returns instance of the Web3 client."""
     # Either http or ws endpoint must be provided (prefer ws over http)
     if ws_endpoint:
-        w3 = Web3(Web3.WebsocketProvider(ws_endpoint))
+        w3 = Web3(
+            Web3.WebsocketProvider(ws_endpoint, websocket_timeout=ws_endpoint_timeout)
+        )
         logger.info(f"Using Web3 websocket endpoint {ws_endpoint}")
 
         if inject_retry_request: