Merge pull request #498 from LedgerHQ/feat/apa/python_client_improvem…

…ents

Python client & tests improvements

client/pyproject.toml

@@ -28,8 +28,7 @@ dynamic = [ "version" ]
 requires-python = ">=3.7"
 dependencies = [
     "ragger[speculos]",
-    "simple-rlp",
-    "pysha3",
+    "web3~=6.0",
 ]
 
 [tools.setuptools]

client/src/ledger_app_clients/ethereum/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.0"
+__version__ = "0.2.0"

client/src/ledger_app_clients/ethereum/client.py

@@ -2,25 +2,14 @@
 from enum import IntEnum
 from ragger.backend import BackendInterface
 from ragger.utils import RAPDU
-from typing import List, Optional, Union
+from typing import Optional
 
 from .command_builder import CommandBuilder
 from .eip712 import EIP712FieldType
 from .keychain import sign_data, Key
 from .tlv import format_tlv
 
-
-WEI_IN_ETH = 1e+18
-GWEI_IN_ETH = 1e+9
-
-
-class TxData:
-    selector: bytes
-    parameters: list[bytes]
-
-    def __init__(self, selector: bytes, params: list[bytes]):
-        self.selector = selector
-        self.parameters = params
+from web3 import Web3
 
 
 class StatusWord(IntEnum):
@@ -64,7 +53,7 @@ def eip712_send_struct_def_struct_field(self,
                                             field_type: EIP712FieldType,
                                             type_name: str,
                                             type_size: int,
-                                            array_levels: List,
+                                            array_levels: list,
                                             key_name: str):
         return self._send(self._cmd_builder.eip712_send_struct_def_struct_field(
                           field_type,
@@ -86,7 +75,7 @@ def eip712_send_struct_impl_struct_field(self, raw_value: bytes):
                 pass
         return self._send(chunks[-1])
 
-    def eip712_sign_new(self, bip32_path: str, verbose: bool):
+    def eip712_sign_new(self, bip32_path: str):
         return self._send(self._cmd_builder.eip712_sign_new(bip32_path))
 
     def eip712_sign_legacy(self,
@@ -106,79 +95,26 @@ def eip712_filtering_message_info(self, name: str, filters_count: int, sig: byte
     def eip712_filtering_show_field(self, name: str, sig: bytes):
         return self._send(self._cmd_builder.eip712_filtering_show_field(name, sig))
 
-    def _sign(self, bip32_path: str, raw_tx: bytes):
-        chunks = self._cmd_builder.sign(bip32_path, raw_tx)
+    def sign(self,
+             bip32_path: str,
+             tx_params: dict):
+        tx = Web3().eth.account.create().sign_transaction(tx_params).rawTransaction
+        prefix = bytes()
+        suffix = []
+        if tx[0] in [0x01, 0x02]:
+            prefix = tx[:1]
+            tx = tx[len(prefix):]
+        else:  # legacy
+            if "chainId" in tx_params:
+                suffix = [int(tx_params["chainId"]), bytes(), bytes()]
+        decoded = rlp.decode(tx)[:-3]  # remove already computed signature
+        tx = prefix + rlp.encode(decoded + suffix)
+        chunks = self._cmd_builder.sign(bip32_path, tx, suffix)
         for chunk in chunks[:-1]:
             with self._send(chunk):
                 pass
         return self._send(chunks[-1])
 
-    def _data_to_payload(self, data: TxData) -> bytes:
-        payload = bytearray(data.selector)
-        for param in data.parameters:
-            payload += param.rjust(32, b'\x00')
-        return payload
-
-    def _sign_common(self,
-                     tx: list,
-                     gas_price: float,
-                     gas_limit: int,
-                     destination: bytes,
-                     amount: float,
-                     data: Optional[TxData]):
-        tx.append(int(gas_price * GWEI_IN_ETH))
-        tx.append(gas_limit)
-        tx.append(destination)
-        if amount > 0:
-            tx.append(int(amount * WEI_IN_ETH))
-        else:
-            tx.append(bytes())
-        if data is not None:
-            tx.append(self._data_to_payload(data))
-        else:
-            tx.append(bytes())
-        return tx
-
-    def sign_legacy(self,
-                    bip32_path: str,
-                    nonce: int,
-                    gas_price: float,
-                    gas_limit: int,
-                    destination: bytes,
-                    amount: float,
-                    chain_id: int,
-                    data: Optional[TxData] = None):
-        tx: List[Union[int, bytes]] = list()
-        tx.append(nonce)
-        tx = self._sign_common(tx, gas_price, gas_limit, destination, amount, data)
-        tx.append(chain_id)
-        tx.append(bytes())
-        tx.append(bytes())
-        return self._sign(bip32_path, rlp.encode(tx))
-
-    def sign_1559(self,
-                  bip32_path: str,
-                  chain_id: int,
-                  nonce: int,
-                  max_prio_gas_price: float,
-                  max_gas_price: float,
-                  gas_limit: int,
-                  destination: bytes,
-                  amount: float,
-                  data: Optional[TxData] = None,
-                  access_list=list()):
-        tx: List[Union[int, bytes]] = list()
-        tx.append(chain_id)
-        tx.append(nonce)
-        tx.append(int(max_prio_gas_price * GWEI_IN_ETH))
-        tx = self._sign_common(tx, max_gas_price, gas_limit, destination, amount, data)
-        tx.append(access_list)
-        tx.append(False)
-        tx.append(bytes())
-        tx.append(bytes())
-        # prefix with transaction type
-        return self._sign(bip32_path, b'\x02' + rlp.encode(tx))
-
     def get_challenge(self):
         return self._send(self._cmd_builder.get_challenge())
 
@@ -286,5 +222,12 @@ def set_external_plugin(self,
             tmp = self._cmd_builder.set_external_plugin(plugin_name, contract_address, method_selelector, bytes())
 
             # skip APDU header & empty sig
-            sig = sign_data(Key.SET_PLUGIN, tmp[5:-1])
+            sig = sign_data(Key.CAL, tmp[5:])
         return self._send(self._cmd_builder.set_external_plugin(plugin_name, contract_address, method_selelector, sig))
+
+    def personal_sign(self, path: str, msg: bytes):
+        chunks = self._cmd_builder.personal_sign(path, msg)
+        for chunk in chunks[:-1]:
+            with self._send(chunk):
+                pass
+        return self._send(chunks[-1])

client/src/ledger_app_clients/ethereum/command_builder.py

@@ -5,14 +5,14 @@
 from enum import IntEnum
 from typing import Optional
 from ragger.bip import pack_derivation_path
-from typing import List
 
 from .eip712 import EIP712FieldType
 
 
 class InsType(IntEnum):
     GET_PUBLIC_ADDR = 0x02
     SIGN = 0x04
+    PERSONAL_SIGN = 0x08
     PROVIDE_NFT_INFORMATION = 0x14
     SET_PLUGIN = 0x16
     EIP712_SEND_STRUCT_DEF = 0x1a
@@ -75,7 +75,7 @@ def eip712_send_struct_def_struct_field(self,
                                             field_type: EIP712FieldType,
                                             type_name: str,
                                             type_size: int,
-                                            array_levels: List,
+                                            array_levels: list,
                                             key_name: str) -> bytes:
         data = bytearray()
         typedesc = 0
@@ -115,7 +115,7 @@ def eip712_send_struct_impl_array(self, size: int) -> bytes:
                                P2Type.ARRAY,
                                data)
 
-    def eip712_send_struct_impl_struct_field(self, data: bytearray) -> List[bytes]:
+    def eip712_send_struct_impl_struct_field(self, data: bytearray) -> list[bytes]:
         chunks = list()
         # Add a 16-bit integer with the data's byte length (network byte order)
         data_w_length = bytearray()
@@ -195,17 +195,27 @@ def set_external_plugin(self, plugin_name: str, contract_address: bytes, selecto
                                0x00,
                                data)
 
-    def sign(self, bip32_path: str, rlp_data: bytes) -> list[bytes]:
+    def sign(self, bip32_path: str, rlp_data: bytes, vrs: list) -> list[bytes]:
         apdus = list()
         payload = pack_derivation_path(bip32_path)
         payload += rlp_data
         p1 = P1Type.SIGN_FIRST_CHUNK
         while len(payload) > 0:
+            chunk_size = 0xff
+
+            # TODO: Fix the app & remove this, issue #409
+            if len(vrs) == 3:
+                if len(payload) > chunk_size:
+                    import rlp
+                    diff = len(rlp.encode(vrs)) - (len(payload) - chunk_size)
+                    if diff > 0:
+                        chunk_size -= diff
+
             apdus.append(self._serialize(InsType.SIGN,
                                          p1,
                                          0x00,
-                                         payload[:0xff]))
-            payload = payload[0xff:]
+                                         payload[:chunk_size]))
+            payload = payload[chunk_size:]
             p1 = P1Type.SIGN_SUBSQT_CHUNK
         return apdus
 
@@ -284,3 +294,19 @@ def provide_nft_information(self,
         payload.append(len(sig))
         payload += sig
         return self._serialize(InsType.PROVIDE_NFT_INFORMATION, 0x00, 0x00, payload)
+
+    def personal_sign(self, path: str, msg: bytes):
+        payload = pack_derivation_path(path)
+        payload += struct.pack(">I", len(msg))
+        payload += msg
+        chunks = list()
+        p1 = P1Type.SIGN_FIRST_CHUNK
+        while len(payload) > 0:
+            chunk_size = 0xff
+            chunks.append(self._serialize(InsType.PERSONAL_SIGN,
+                                          p1,
+                                          0x00,
+                                          payload[:chunk_size]))
+            payload = payload[chunk_size:]
+            p1 = P1Type.SIGN_SUBSQT_CHUNK
+        return chunks