olas-operate-middleware 0.10.19__tar.gz → 0.11.0__tar.gz

{olas_operate_middleware-0.10.19 → olas_operate_middleware-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: olas-operate-middleware
-Version: 0.10.19
+Version: 0.11.0
 Summary: 
 License-File: LICENSE
 Author: David Vilela
@@ -30,6 +30,7 @@ Requires-Dist: halo (==0.0.31)
 Requires-Dist: hexbytes (==0.3.1)
 Requires-Dist: ipfshttpclient (==0.8.0a2)
 Requires-Dist: jsonschema (==4.3.3)
+Requires-Dist: multiaddr (==0.0.9)
 Requires-Dist: multidict (==6.0.5)
 Requires-Dist: open-aea-cli-ipfs (==1.65.0)
 Requires-Dist: open-aea-ledger-cosmos (==1.65.0)
@@ -38,6 +39,7 @@ Requires-Dist: open-aea-ledger-ethereum-flashbots (==1.65.0)
 Requires-Dist: open-autonomy (>=0.20.2,<0.21.0)
 Requires-Dist: psutil (>=5.9.8,<6.0.0)
 Requires-Dist: pyinstaller (>=6.8.0,<7.0.0)
+Requires-Dist: requests-mock (>=1.12.1,<2.0.0)
 Requires-Dist: requests-toolbelt (==1.0.0)
 Requires-Dist: starlette (==0.37.2)
 Requires-Dist: twikit (==2.2.0)

{olas_operate_middleware-0.10.19 → olas_operate_middleware-0.11.0}/operate/bridge/bridge_manager.py

@@ -42,10 +42,9 @@ from operate.bridge.providers.provider import Provider, ProviderRequest
 from operate.bridge.providers.relay_provider import RelayProvider
 from operate.constants import ZERO_ADDRESS
 from operate.ledger.profiles import USDC
-from operate.operate_types import Chain
+from operate.operate_types import Chain, ChainAmounts
 from operate.resource import LocalResource
 from operate.services.manage import get_assets_balances
-from operate.utils import merge_sum_dicts, subtract_dicts
 from operate.wallet.master import MasterWalletManager
 
 
@@ -187,13 +186,13 @@ class BridgeManager:
         path: Path,
         wallet_manager: MasterWalletManager,
         logger: logging.Logger,
-        quote_validity_period: int = DEFAULT_BUNDLE_VALIDITY_PERIOD,
+        bundle_validity_period: int = DEFAULT_BUNDLE_VALIDITY_PERIOD,
     ) -> None:
         """Initialize bridge manager."""
         self.path = path
         self.wallet_manager = wallet_manager
         self.logger = logger
-        self.quote_validity_period = quote_validity_period
+        self.bundle_validity_period = bundle_validity_period
         self.path.mkdir(exist_ok=True)
         (self.path / EXECUTED_BUNDLES_PATH).mkdir(exist_ok=True)
         self.data: BridgeManagerData = cast(
@@ -251,7 +250,7 @@ class BridgeManager:
             self.logger.info("[BRIDGE MANAGER] Force bundle update.")
             self.quote_bundle(bundle)
             self._store_data()
-        elif now > bundle.timestamp + self.quote_validity_period:
+        elif now > bundle.timestamp + self.bundle_validity_period:
             self.logger.info("[BRIDGE MANAGER] Bundle expired.")
             self.quote_bundle(bundle)
             self._store_data()
@@ -335,7 +334,7 @@ class BridgeManager:
 
         bundle = self._get_updated_bundle(requests_params, force_update)
 
-        balances = {}
+        balances = ChainAmounts()
         for chain in bundle.get_from_chains():
             ledger_api = self.wallet_manager.load(chain.ledger_type).ledger_api(chain)
             balances[chain.value] = get_assets_balances(
@@ -346,9 +345,8 @@ class BridgeManager:
 
         bridge_total_requirements = self.bridge_total_requirements(bundle)
 
-        bridge_refill_requirements = cast(
-            t.Dict[str, t.Dict[str, t.Dict[str, int]]],
-            subtract_dicts(bridge_total_requirements, balances),
+        bridge_refill_requirements = ChainAmounts.shortfalls(
+            bridge_total_requirements, balances
         )
 
         is_refill_required = any(
@@ -364,7 +362,7 @@ class BridgeManager:
                 "balances": balances,
                 "bridge_refill_requirements": bridge_refill_requirements,
                 "bridge_total_requirements": bridge_total_requirements,
-                "expiration_timestamp": bundle.timestamp + self.quote_validity_period,
+                "expiration_timestamp": bundle.timestamp + self.bundle_validity_period,
                 "is_refill_required": is_refill_required,
             }
         )
@@ -441,14 +439,14 @@ class BridgeManager:
             "bridge_request_status": provider_request_status,
         }
 
-    def bridge_total_requirements(self, bundle: ProviderRequestBundle) -> t.Dict:
+    def bridge_total_requirements(self, bundle: ProviderRequestBundle) -> ChainAmounts:
         """Sum bridge requirements."""
         requirements = []
         for provider_request in bundle.provider_requests:
             provider = self._providers[provider_request.provider_id]
             requirements.append(provider.requirements(provider_request))
 
-        return merge_sum_dicts(*requirements)
+        return ChainAmounts.add(*requirements)
 
     def quote_bundle(self, bundle: ProviderRequestBundle) -> None:
         """Update the bundle with the quotes."""

{olas_operate_middleware-0.10.19 → olas_operate_middleware-0.11.0}/operate/bridge/providers/lifi_provider.py

@@ -38,6 +38,7 @@ from operate.bridge.providers.provider import (
     QuoteData,
 )
 from operate.constants import ZERO_ADDRESS
+from operate.ledger import update_tx_with_gas_estimate, update_tx_with_gas_pricing
 from operate.operate_types import Chain
 
 
@@ -240,8 +241,8 @@ class LiFiProvider(Provider):
             amount=from_amount,
         )
         approve_tx["gas"] = 200_000  # TODO backport to ERC20 contract as default
-        Provider._update_with_gas_pricing(approve_tx, from_ledger_api)
-        Provider._update_with_gas_estimate(approve_tx, from_ledger_api)
+        update_tx_with_gas_pricing(approve_tx, from_ledger_api)
+        update_tx_with_gas_estimate(approve_tx, from_ledger_api)
         return approve_tx
 
     def _get_bridge_tx(self, provider_request: ProviderRequest) -> t.Optional[t.Dict]:
@@ -285,8 +286,8 @@ class LiFiProvider(Provider):
                 transaction_request["from"]
             ),
         }
-        Provider._update_with_gas_pricing(bridge_tx, from_ledger_api)
-        Provider._update_with_gas_estimate(bridge_tx, from_ledger_api)
+        update_tx_with_gas_pricing(bridge_tx, from_ledger_api)
+        update_tx_with_gas_estimate(bridge_tx, from_ledger_api)
         return bridge_tx
 
     def _get_txs(

{olas_operate_middleware-0.10.19 → olas_operate_middleware-0.11.0}/operate/bridge/providers/native_bridge_provider.py

@@ -53,6 +53,7 @@ from operate.data.contracts.l2_standard_bridge.contract import L2StandardBridge
 from operate.data.contracts.optimism_mintable_erc20.contract import (
     OptimismMintableERC20,
 )
+from operate.ledger import update_tx_with_gas_estimate, update_tx_with_gas_pricing
 from operate.ledger.profiles import ERC20_TOKENS, EXPLORER_URL
 from operate.operate_types import Chain
 from operate.wallet.master import MasterWalletManager
@@ -96,7 +97,7 @@ class BridgeContractAdaptor(ABC):
         if from_token == ZERO_ADDRESS and to_token == ZERO_ADDRESS:
             return True
 
-        for token_map in ERC20_TOKENS:
+        for token_map in ERC20_TOKENS.values():
             if (
                 Chain(from_chain) in token_map
                 and Chain(to_chain) in token_map
@@ -512,8 +513,8 @@ class NativeBridgeProvider(Provider):
             amount=to_amount,
         )
         approve_tx["gas"] = 200_000  # TODO backport to ERC20 contract as default
-        Provider._update_with_gas_pricing(approve_tx, from_ledger_api)
-        Provider._update_with_gas_estimate(approve_tx, from_ledger_api)
+        update_tx_with_gas_pricing(approve_tx, from_ledger_api)
+        update_tx_with_gas_estimate(approve_tx, from_ledger_api)
         return approve_tx
 
     def _get_bridge_tx(self, provider_request: ProviderRequest) -> t.Optional[t.Dict]:
@@ -534,8 +535,8 @@ class NativeBridgeProvider(Provider):
             from_ledger_api=from_ledger_api, provider_request=provider_request
         )
 
-        Provider._update_with_gas_pricing(bridge_tx, from_ledger_api)
-        Provider._update_with_gas_estimate(bridge_tx, from_ledger_api)
+        update_tx_with_gas_pricing(bridge_tx, from_ledger_api)
+        update_tx_with_gas_estimate(bridge_tx, from_ledger_api)
         return bridge_tx
 
     def _get_txs(

{olas_operate_middleware-0.10.19 → olas_operate_middleware-0.11.0}/operate/bridge/providers/provider.py

@@ -28,12 +28,10 @@ import typing as t
 import uuid
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
-from math import ceil
 
 from aea.crypto.base import LedgerApi
 from autonomy.chain.tx import TxSettler
 from web3 import Web3
-from web3.middleware import geth_poa_middleware
 
 from operate.constants import (
     ON_CHAIN_INTERACT_RETRIES,
@@ -41,16 +39,12 @@ from operate.constants import (
     ON_CHAIN_INTERACT_TIMEOUT,
     ZERO_ADDRESS,
 )
-from operate.operate_types import Chain
+from operate.ledger import get_default_ledger_api, update_tx_with_gas_pricing
+from operate.operate_types import Chain, ChainAmounts
 from operate.resource import LocalResource
 from operate.wallet.master import MasterWalletManager
 
 
-GAS_ESTIMATE_FALLBACK_ADDRESSES = [
-    "0x000000000000000000000000000000000000dEaD",
-    "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",  # nosec
-]
-
 DEFAULT_MAX_QUOTE_RETRIES = 3
 PROVIDER_REQUEST_PREFIX = "r-"
 MESSAGE_QUOTE_ZERO = "Zero-amount quote requested."
@@ -66,8 +60,6 @@ MESSAGE_REQUIREMENTS_QUOTE_FAILED = "Cannot compute requirements for failed quot
 
 ERC20_APPROVE_SELECTOR = "0x095ea7b3"  # First 4 bytes of Web3.keccak(text='approve(address,uint256)').hex()[:10]
 
-GAS_ESTIMATE_BUFFER = 1.10
-
 
 @dataclass
 class QuoteData(LocalResource):
@@ -225,28 +217,12 @@ class Provider(ABC):
     def _from_ledger_api(self, provider_request: ProviderRequest) -> LedgerApi:
         """Get the from ledger api."""
         from_chain = provider_request.params["from"]["chain"]
-        chain = Chain(from_chain)
-        wallet = self.wallet_manager.load(chain.ledger_type)
-        ledger_api = wallet.ledger_api(chain)
-
-        # TODO: Backport to open aea/autonomy
-        if chain == Chain.OPTIMISM:
-            ledger_api.api.middleware_onion.inject(geth_poa_middleware, layer=0)
-
-        return ledger_api
+        return get_default_ledger_api(Chain(from_chain))
 
     def _to_ledger_api(self, provider_request: ProviderRequest) -> LedgerApi:
         """Get the from ledger api."""
-        from_chain = provider_request.params["to"]["chain"]
-        chain = Chain(from_chain)
-        wallet = self.wallet_manager.load(chain.ledger_type)
-        ledger_api = wallet.ledger_api(chain)
-
-        # TODO: Backport to open aea/autonomy
-        if chain == Chain.OPTIMISM:
-            ledger_api.api.middleware_onion.inject(geth_poa_middleware, layer=0)
-
-        return ledger_api
+        to_chain = provider_request.params["to"]["chain"]
+        return get_default_ledger_api(Chain(to_chain))
 
     @abstractmethod
     def quote(self, provider_request: ProviderRequest) -> None:
@@ -260,7 +236,7 @@ class Provider(ABC):
         """Get the sorted list of transactions to execute the quote."""
         raise NotImplementedError()
 
-    def requirements(self, provider_request: ProviderRequest) -> t.Dict:
+    def requirements(self, provider_request: ProviderRequest) -> ChainAmounts:
         """Gets the requirements to execute the quote, with updated gas estimation."""
         self.logger.info(f"[PROVIDER] Requirements for request {provider_request.id}.")
 
@@ -274,14 +250,16 @@ class Provider(ABC):
         txs = self._get_txs(provider_request)
 
         if not txs:
-            return {
-                from_chain: {
-                    from_address: {
-                        ZERO_ADDRESS: 0,
-                        from_token: 0,
+            return ChainAmounts(
+                {
+                    from_chain: {
+                        from_address: {
+                            ZERO_ADDRESS: 0,
+                            from_token: 0,
+                        }
                     }
                 }
-            }
+            )
 
         total_native = 0
         total_gas_fees = 0
@@ -291,7 +269,7 @@ class Provider(ABC):
             self.logger.debug(
                 f"[PROVIDER] Processing transaction {tx_label} for request {provider_request.id}."
             )
-            self._update_with_gas_pricing(tx, from_ledger_api)
+            update_tx_with_gas_pricing(tx, from_ledger_api)
             gas_key = "gasPrice" if "gasPrice" in tx else "maxFeePerGas"
             gas_fees = tx.get(gas_key, 0) * tx["gas"]
             tx_value = int(tx.get("value", 0))
@@ -319,13 +297,15 @@ class Provider(ABC):
             f"[PROVIDER] Total gas fees for request {provider_request.id}: {total_gas_fees} native units."
         )
 
-        result = {
-            from_chain: {
-                from_address: {
-                    ZERO_ADDRESS: total_native,
+        result = ChainAmounts(
+            {
+                from_chain: {
+                    from_address: {
+                        ZERO_ADDRESS: total_native,
+                    }
                 }
             }
-        }
+        )
 
         if from_token != ZERO_ADDRESS:
             result[from_chain][from_address][from_token] = total_token
@@ -487,48 +467,3 @@ class Provider(ABC):
         receipt = ledger_api.api.eth.get_transaction_receipt(tx_hash)
         block = ledger_api.api.eth.get_block(receipt.blockNumber)
         return block.timestamp
-
-    # TODO backport to open aea/autonomy
-    # TODO This gas pricing management should possibly be done at a lower level in the library
-    @staticmethod
-    def _update_with_gas_pricing(tx: t.Dict, ledger_api: LedgerApi) -> None:
-        tx.pop("maxFeePerGas", None)
-        tx.pop("gasPrice", None)
-        tx.pop("maxPriorityFeePerGas", None)
-
-        gas_pricing = ledger_api.try_get_gas_pricing()
-        if gas_pricing is None:
-            raise RuntimeError("Unable to retrieve gas pricing.")
-
-        if "maxFeePerGas" in gas_pricing and "maxPriorityFeePerGas" in gas_pricing:
-            tx["maxFeePerGas"] = gas_pricing["maxFeePerGas"]
-            tx["maxPriorityFeePerGas"] = gas_pricing["maxPriorityFeePerGas"]
-        elif "gasPrice" in gas_pricing:
-            tx["gasPrice"] = gas_pricing["gasPrice"]
-        else:
-            raise RuntimeError("Retrieved invalid gas pricing.")
-
-    # TODO backport to open aea/autonomy
-    @staticmethod
-    def _update_with_gas_estimate(tx: t.Dict, ledger_api: LedgerApi) -> None:
-        print(
-            f"[PROVIDER] Trying to update transaction gas {tx['from']=} {tx['gas']=}."
-        )
-        original_from = tx["from"]
-        original_gas = tx.get("gas", 1)
-
-        for address in [original_from] + GAS_ESTIMATE_FALLBACK_ADDRESSES:
-            tx["from"] = address
-            tx["gas"] = 1
-            ledger_api.update_with_gas_estimate(tx)
-            if tx["gas"] > 1:
-                print(
-                    f"[PROVIDER] Gas estimated successfully {tx['from']=} {tx['gas']=}."
-                )
-                break
-
-        tx["from"] = original_from
-        if tx["gas"] == 1:
-            tx["gas"] = original_gas
-            print(f"[PROVIDER] Unable to estimate gas. Restored {tx['gas']=}.")
-        tx["gas"] = ceil(tx["gas"] * GAS_ESTIMATE_BUFFER)

{olas_operate_middleware-0.10.19 → olas_operate_middleware-0.11.0}/operate/bridge/providers/relay_provider.py

@@ -39,6 +39,7 @@ from operate.bridge.providers.provider import (
     ProviderRequestStatus,
     QuoteData,
 )
+from operate.ledger import update_tx_with_gas_estimate, update_tx_with_gas_pricing
 from operate.operate_types import Chain
 
 
@@ -258,10 +259,10 @@ class RelayProvider(Provider):
                     timestamp=int(time.time()),
                 )
             except requests.RequestException as e:
+                response_json = response.json()
                 self.logger.warning(
-                    f"[RELAY PROVIDER] Request failed on attempt {attempt}/{DEFAULT_MAX_QUOTE_RETRIES}: {e}."
+                    f"[RELAY PROVIDER] Request failed on attempt {attempt}/{DEFAULT_MAX_QUOTE_RETRIES}: {response_json}."
                 )
-                response_json = response.json()
                 quote_data = QuoteData(
                     eta=None,
                     elapsed_time=time.time() - start,
@@ -338,8 +339,8 @@ class RelayProvider(Provider):
                 tx["maxFeePerGas"] = int(tx.get("maxFeePerGas", 0))
                 tx["maxPriorityFeePerGas"] = int(tx.get("maxPriorityFeePerGas", 0))
                 tx["nonce"] = from_ledger_api.api.eth.get_transaction_count(tx["from"])
-                Provider._update_with_gas_pricing(tx, from_ledger_api)
-                Provider._update_with_gas_estimate(tx, from_ledger_api)
+                update_tx_with_gas_pricing(tx, from_ledger_api)
+                update_tx_with_gas_estimate(tx, from_ledger_api)
                 txs.append((f"{step['id']}-{i}", tx))
 
         return txs