olas-operate-middleware 0.1.0rc59__py3-none-any.whl → 0.13.2__py3-none-any.whl

operate/data/contracts/l1_standard_bridge/contract.py

@@ -0,0 +1,158 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2024 Valory AG
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# ------------------------------------------------------------------------------
+
+"""This module contains the class to connect to the `L1StandardBridge` contract."""
+
+from math import ceil
+
+from aea.common import JSONLike
+from aea.configurations.base import PublicId
+from aea.contracts.base import Contract
+from aea.crypto.base import LedgerApi
+
+
+PLACEHOLDER_NATIVE_TOKEN_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"  # nosec
+
+# Minimum gas required for L2 execution when bridging from L1.
+# Prevents underfunded messages that could fail on L2.
+DEFAULT_BRIDGE_MIN_GAS_LIMIT = 300_000
+
+DEFAULT_GAS_BRIDGE_ETH_TO = 800_000
+DEFAULT_GAS_BRIDGE_ERC20_TO = 800_000
+
+# By simulations, nonzero-ERC20-bridge gas ~ 1.05 zero-ERC20-bridge gas
+NONZERO_ERC20_GAS_FACTOR = 1.15
+
+
+class L1StandardBridge(Contract):
+    """Optimism L1StandardBridge."""
+
+    contract_id = PublicId.from_str("valory/l1_standard_bridge:0.1.0")
+
+    @classmethod
+    def supports_bridge_eth_to(
+        cls,
+        ledger_api: LedgerApi,
+        contract_address: str,
+    ) -> bool:
+        """Checks if native ETH bridging via `bridgeETHTo` is supported."""
+        contract_instance = cls.get_instance(
+            ledger_api=ledger_api, contract_address=contract_address
+        )        
+        try:
+            contract_instance.functions.bridgeETHTo(
+                "0x0000000000000000000000000000000000000000",
+                0,
+                b""
+            ).call({"from": PLACEHOLDER_NATIVE_TOKEN_ADDRESS, "value": 0})
+            return True
+        except Exception:  # pylint: disable=broad-except
+            return False
+
+    @classmethod
+    def build_bridge_eth_to_tx(
+        cls,
+        ledger_api: LedgerApi,
+        contract_address: str,
+        sender: str,
+        to: str,
+        amount: int,
+        min_gas_limit: int,
+        extra_data: bytes,
+        raise_on_try: bool = False,
+    ) -> JSONLike:
+        """Build bridgeETHTo tx."""
+        contract_instance = cls.get_instance(
+            ledger_api=ledger_api, contract_address=contract_address
+        )
+        tx = contract_instance.functions.bridgeETHTo(
+            to, min_gas_limit, extra_data
+        ).build_transaction(
+            {
+                "from": sender,
+                "value": amount,
+                "gas": DEFAULT_GAS_BRIDGE_ETH_TO,
+                "gasPrice": ledger_api.api.eth.gas_price,
+                "nonce": ledger_api.api.eth.get_transaction_count(sender),
+            }
+        )
+        return ledger_api.update_with_gas_estimate(
+            transaction=tx,
+            raise_on_try=raise_on_try,
+        )
+
+    @classmethod
+    def build_bridge_erc20_to_tx(
+        cls,
+        ledger_api: LedgerApi,
+        contract_address: str,
+        sender: str,
+        local_token: str,
+        remote_token: str,
+        to: str,
+        amount: int,
+        min_gas_limit: int,
+        extra_data: bytes,
+        raise_on_try: bool = False,
+    ) -> JSONLike:
+        """Build bridgeERC20To tx."""
+        contract_instance = cls.get_instance(
+            ledger_api=ledger_api, contract_address=contract_address
+        )
+        tx = contract_instance.functions.bridgeERC20To(
+            local_token, remote_token, to, amount, min_gas_limit, extra_data
+        ).build_transaction(
+            {
+                "from": sender,
+                "gas": 1,
+                "gasPrice": ledger_api.api.eth.gas_price,
+                "nonce": ledger_api.api.eth.get_transaction_count(sender),
+            }
+        )
+
+        ledger_api.update_with_gas_estimate(
+            transaction=tx,
+            raise_on_try=raise_on_try,
+        )
+
+        if tx["gas"] > 1:
+            return tx
+
+        tx_zero = contract_instance.functions.bridgeERC20To(
+            local_token, remote_token, to, 0, min_gas_limit, extra_data
+        ).build_transaction(
+            {
+                "from": PLACEHOLDER_NATIVE_TOKEN_ADDRESS,
+                "gas": 1,
+                "gasPrice": ledger_api.api.eth.gas_price,
+                "nonce": ledger_api.api.eth.get_transaction_count(sender),
+            }
+        )
+
+        ledger_api.update_with_gas_estimate(
+            transaction=tx_zero,
+            raise_on_try=raise_on_try,
+        )
+
+        if tx_zero["gas"] > 1:
+            tx["gas"] = ceil(tx_zero["gas"] * NONZERO_ERC20_GAS_FACTOR)
+            return tx
+
+        tx["gas"] = DEFAULT_GAS_BRIDGE_ERC20_TO
+        return tx

operate/data/contracts/l1_standard_bridge/contract.yaml

@@ -0,0 +1,23 @@
+name: l1_standard_bridge
+author: valory
+version: 0.1.0
+type: contract
+description: Optimism L1 Standard Bridge
+license: Apache-2.0
+aea_version: '>=1.0.0, <2.0.0'
+fingerprint:
+  __init__.py: bafybeifsbxn6hlccnpgqnpvaz3ph6ajl4is4mcyerr6aqp7heggagcphye
+  build/L1StandardBridge.json: bafybeidq6jt7zmedtuxbbyggiqhu7w6543bunyd2vrbibg6y2svxsi2q5m
+  contract.py: bafybeienitro6gds2ny7guziwdu3uapmj3xxuzmqyvsect4zqmrouity2e
+fingerprint_ignore_patterns: []
+contracts: []
+class_name: L1StandardBridge
+contract_interface_paths:
+  ethereum: build/L1StandardBridge.json
+dependencies:
+  open-aea-ledger-ethereum:
+    version: ==1.60.0
+  open-aea-test-autonomy:
+    version: ==0.18.3
+  web3:
+    version: <7,>=6.0.0

operate/data/contracts/l2_standard_bridge/__init__.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2025 Valory AG
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# ------------------------------------------------------------------------------
+
+"""This module contains the support resources for the `L2StandardBridge` contract."""