Merge pull request #2398 from valory-xyz/jmoreira-valory/predict-665-add-tests-for-pr-2394

Tests for gas multiplier

Author: jmoreira-valory

autonomy/chain/tx.py

@@ -124,7 +124,7 @@ def __init__(
         self.retries = retries or DEFAULT_ON_CHAIN_INTERACT_RETRIES
         self.sleep = sleep or DEFAULT_ON_CHAIN_INTERACT_SLEEP
 
-        if gas_estimate_multiplier:
+        if gas_estimate_multiplier is not None:
             if gas_estimate_multiplier > 2.5:
                 logger.warning(f"{gas_estimate_multiplier=} is unusually high.")
             if gas_estimate_multiplier <= 0:

tests/test_autonomy/test_chain/test_tx.py

@@ -605,3 +605,89 @@ def _update_with_gas_estimate_mock(tx: dict) -> dict:
 
         settler.settle()
         assert settler.tx_receipt is not None
+
+
+def test_gas_estimate_multiplier() -> None:
+    """Test gas_estimate_multiplier parameter."""
+
+    def _tx_builder() -> dict:
+        return {
+            "from": "0x123",
+            "to": "0x456",
+            "value": 100,
+            "gas": 100,
+        }
+
+    # Test default multiplier (should be 1.0)
+    settler = TxSettler(
+        ledger_api=mock.Mock(
+            try_get_gas_pricing=lambda **kwargs: {
+                "maxFeePerGas": 100,
+                "maxPriorityFeePerGas": 100,
+            },
+            update_with_gas_estimate=lambda tx: {**tx, "gas": 100},
+        ),
+        crypto=mock.Mock(sign_transaction=lambda transaction: transaction),
+        chain_type=ChainType.LOCAL,
+        tx_builder=_tx_builder,
+    )
+    assert settler.gas_multiplier == 1.0
+
+    # Test custom multiplier
+    settler_with_multiplier = TxSettler(
+        ledger_api=mock.Mock(
+            try_get_gas_pricing=lambda **kwargs: {
+                "maxFeePerGas": 100,
+                "maxPriorityFeePerGas": 100,
+            },
+            update_with_gas_estimate=lambda tx: {**tx, "gas": 100},
+        ),
+        crypto=mock.Mock(sign_transaction=lambda transaction: transaction),
+        chain_type=ChainType.LOCAL,
+        tx_builder=_tx_builder,
+        gas_estimate_multiplier=1.5,
+    )
+    assert settler_with_multiplier.gas_multiplier == 1.5
+
+    # Test that gas is multiplied correctly in transaction
+    settler_with_multiplier.transact(dry_run=False)
+    assert settler_with_multiplier.tx_dict is not None
+    assert settler_with_multiplier.tx_dict["gas"] == 150  # 100 * 1.5
+
+    # Test invalid multiplier (must be positive)
+    with pytest.raises(ValueError, match="gas_estimate_multiplier.*must be positive"):
+        TxSettler(
+            ledger_api=mock.Mock(),
+            crypto=mock.Mock(),
+            chain_type=ChainType.LOCAL,
+            tx_builder=_tx_builder,
+            gas_estimate_multiplier=0,
+        )
+
+    with pytest.raises(ValueError, match="gas_estimate_multiplier.*must be positive"):
+        TxSettler(
+            ledger_api=mock.Mock(),
+            crypto=mock.Mock(),
+            chain_type=ChainType.LOCAL,
+            tx_builder=_tx_builder,
+            gas_estimate_multiplier=-1.0,
+        )
+
+
+@mock.patch("autonomy.chain.tx.logger")
+def test_gas_estimate_multiplier_warning(logger: mock.Mock) -> None:
+    """Test that gas_estimate_multiplier warns when > 2.5."""
+
+    def _tx_builder() -> dict:
+        return {"from": "0x123", "to": "0x456", "value": 100}
+
+    TxSettler(
+        ledger_api=mock.Mock(),
+        crypto=mock.Mock(),
+        chain_type=ChainType.LOCAL,
+        tx_builder=_tx_builder,
+        gas_estimate_multiplier=3.0,
+    )
+
+    logger.warning.assert_called_once()  # type: ignore[attr-defined]
+    assert "unusually high" in logger.warning.call_args[0][0]  # type: ignore[attr-defined]

tox.ini

@@ -418,7 +418,7 @@ commands =
 skipsdist = True
 skip_install = True
 deps =
-    tomte[safety]==0.4.0
+    tomte[safety]==0.5.0
     typer<0.17.0  # TODO: Update to a version where this is fixed https://github.com/pyupio/safety/issues/784
 commands =
     safety check -i 37524 -i 38038 -i 37776 -i 38039 -i 39621 -i 40291 -i 39706 -i 41002 -i 51499 -i 67599 -i 70612 -i 82754  # remove 82754 after bumping tomte >0.4.0