Merge pull request oasisprotocol#2397 from oasisprotocol/matevz/feat/rofl-client-py-sign-submit

rofl-client-py: Add support for sign_submit endpoint

Author: matevz

rofl-client/py/pyproject.toml

@@ -22,13 +22,15 @@ classifiers = [
 ]
 
 dependencies = [
+  "cbor2>=5.7.1",
   "httpx>=0.25.0",
+  "web3>=7.14.0",
 ]
 
 [dependency-groups]
 dev = [
-    "pytest>=8.4.1",
-    "ruff>=0.8.4",
+  "pytest>=8.4.1",
+  "ruff>=0.8.4",
 ]
 
 [project.urls]
@@ -105,4 +107,4 @@ known-first-party = ["oasis_rofl_client"]
 quote-style = "double"
 indent-style = "space"
 line-ending = "lf"
-skip-magic-trailing-comma = false
+skip-magic-trailing-comma = false

rofl-client/py/src/oasis_rofl_client/rofl_client.py

@@ -10,7 +10,9 @@
 from enum import Enum
 from typing import Any
 
+import cbor2
 import httpx
+from web3.types import TxParams
 
 logger = logging.getLogger(__name__)
 
@@ -122,6 +124,57 @@ async def generate_key(
         response: dict[str, Any] = await self._appd_request("POST", path, payload)
         return response["key"]
 
+    async def sign_submit(
+        self,
+        tx: TxParams,
+        encrypt: bool = False,
+    ) -> dict[str, Any]:
+        """Sign the given Ethereum transaction with an endorsed ephemeral key and submit it to Sapphire.
+
+        Args:
+            tx: Transaction parameters
+            encrypt: End-to-end encrypt the transaction before submitting (default: False)
+
+        Returns:
+            Deserialized response data object.
+
+        Raises:
+            httpx.HTTPStatusError: If the request fails
+            cbor2.CBORDecodeValueError: If the response data is invalid
+
+        Note: Transaction nonce and gas price are ignored.
+        """
+        payload = {
+            "tx": {
+                "kind": "eth",
+                "data": {
+                    "gas_limit": tx["gas"],
+                    "value": tx["value"],
+                    "data": tx["data"][2:]
+                    if tx["data"].startswith("0x")
+                    else tx["data"],
+                },
+            },
+            "encrypt": encrypt,
+        }
+
+        # Contract create transactions don't have "to". For others, include it.
+        if "to" in tx:
+            payload["tx"]["data"]["to"] = (
+                tx["to"][2:] if tx["to"].startswith("0x") else tx["to"]
+            )
+
+        path = "/rofl/v1/tx/sign-submit"
+
+        response: dict[str, str] = await self._appd_request(
+            "POST", path, payload
+        )
+        result = {}
+        # Decode CBOR-encoded data field to python object.
+        if response.get("data"):
+            result = cbor2.loads(bytes.fromhex(response["data"]))
+        return result
+
     async def get_metadata(self) -> dict[str, str]:
         """Get all user-set metadata key-value pairs.
 

rofl-client/py/tests/test_client.py

@@ -3,6 +3,8 @@
 import unittest
 from unittest.mock import AsyncMock, MagicMock, patch
 
+from web3.types import TxParams
+
 from oasis_rofl_client import KeyKind, RoflClient
 
 
@@ -214,6 +216,54 @@ def test_key_kind_enum_values(self):
         self.assertEqual(KeyKind.ED25519.value, "ed25519")
         self.assertEqual(KeyKind.SECP256K1.value, "secp256k1")
 
+    @patch("oasis_rofl_client.rofl_client.httpx.AsyncClient")
+    async def test_sign_submit(self, mock_client_class):
+        """Test sign_submit method."""
+        # Setup mock
+        mock_response = MagicMock()
+        mock_response.json = lambda: {
+            "data": "a1646661696ca364636f646508666d6f64756c656365766d676d6573736167657272657665727465643a20614a416f4c773d3d"
+        }
+        mock_response.raise_for_status = MagicMock()
+
+        mock_client = AsyncMock()
+        mock_client.post.return_value = mock_response
+        mock_client_class.return_value.__aenter__.return_value = mock_client
+
+        # Test set metadata
+        client = RoflClient()
+        tx: TxParams = {
+            "from": "0x1234567890123456789012345678901234567890",
+            "to": "0x0987654321098765432109876543210987654321",
+            "data": "0xdae1ee1f00000000000000000000000000000000000000000000000000002695a9e649b2",
+            "gas": 21000,
+            "gasPrice": 1000000000,
+            "value": 1000000000,
+            "nonce": 0,
+        }
+
+        response = await client.sign_submit(tx, True)
+
+        self.assertEqual(response, {"fail": {"code": 8, "module": "evm", "message": "reverted: aJAoLw=="}})
+
+        # Verify the API call
+        mock_client.post.assert_called_once_with(
+            "http://localhost/rofl/v1/tx/sign-submit",
+            json={
+                "tx": {
+                    "kind": "eth",
+                    "data": {
+                        "gas_limit": 21000,
+                        "value": 1000000000,
+                        "data": "dae1ee1f00000000000000000000000000000000000000000000000000002695a9e649b2",
+                        "to": "0987654321098765432109876543210987654321",
+                    },
+                },
+                "encrypt": True,
+            },
+            timeout=60.0,
+        )
+
     @patch("oasis_rofl_client.rofl_client.httpx.AsyncClient")
     async def test_get_metadata(self, mock_client_class):
         """Test get_metadata method."""