Added signer field for the Message class

multiversx_sdk/core/constants.py

@@ -25,3 +25,5 @@
 BECH32_ADDRESS_LENGTH = 62
 
 MIN_TRANSACTION_VERSION_THAT_SUPPORTS_OPTIONS = 2
+SDK_PY_SIGNER = "sdk-py"
+UNKNOWN_SIGNER = "unknown"

multiversx_sdk/core/interfaces.py

@@ -32,6 +32,7 @@ class IMessage(Protocol):
     signature: bytes
     address: Optional[IAddress]
     version: int
+    signer: str
 
 
 class IToken(Protocol):

multiversx_sdk/core/message.py

@@ -3,19 +3,23 @@
 from Cryptodome.Hash import keccak
 
 from multiversx_sdk.core.address import Address
-from multiversx_sdk.core.constants import DEFAULT_MESSAGE_VERSION
+from multiversx_sdk.core.constants import (DEFAULT_MESSAGE_VERSION,
+                                           SDK_PY_SIGNER, UNKNOWN_SIGNER)
 from multiversx_sdk.core.interfaces import IAddress, IMessage
 
 
 class Message:
-    def __init__(self, data: bytes,
+    def __init__(self,
+                 data: bytes,
                  signature: bytes = b"",
                  address: Optional[IAddress] = None,
-                 version: int = DEFAULT_MESSAGE_VERSION) -> None:
+                 version: int = DEFAULT_MESSAGE_VERSION,
+                 signer: str = SDK_PY_SIGNER) -> None:
         self.data = data
         self.signature = signature
         self.address = address
         self.version = version
+        self.signer = signer
 
 
 class MessageComputer:
@@ -44,7 +48,8 @@ def pack_message(self, message: IMessage) -> Dict[str, Any]:
             "address": message.address.to_bech32() if message.address else "",
             "message": message.data.hex(),
             "signature": message.signature.hex(),
-            "version": message.version
+            "version": message.version,
+            "signer": message.signer
         }
 
     def unpack_message(self, packed_message: Dict[str, Any]) -> Message:
@@ -58,12 +63,14 @@ def unpack_message(self, packed_message: Dict[str, Any]) -> Message:
         address = Address.from_bech32(address) if address else None
 
         version = packed_message.get("version", DEFAULT_MESSAGE_VERSION)
+        signer = packed_message.get("signer", UNKNOWN_SIGNER)
 
         return Message(
             data=bytes.fromhex(data),
             address=address,
             signature=bytes.fromhex(signature),
-            version=version
+            version=version,
+            signer=signer
         )
 
     def _trim_hex_prefix(self, data: str) -> str:

multiversx_sdk/core/message_test.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 
 from multiversx_sdk.core.address import Address
+from multiversx_sdk.core.constants import SDK_PY_SIGNER, UNKNOWN_SIGNER
 from multiversx_sdk.core.message import Message, MessageComputer
 from multiversx_sdk.wallet.user_signer import UserSigner
 from multiversx_sdk.wallet.user_verifer import UserVerifier
@@ -33,7 +34,8 @@ def test_sign_packed_message_and_verify_unpacked_message():
         "address": "erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th",
         "message": "74657374",
         "signature": "7aff43cd6e3d880a65033bf0a1b16274854fd7dfa9fe5faa7fa9a665ee851afd4c449310f5f1697d348e42d1819eaef69080e33e7652d7393521ed50d7427a0e",
-        "version": 1
+        "version": 1,
+        "signer": SDK_PY_SIGNER
     }
 
     unpacked_message = message_computer.unpack_message(packed_message)
@@ -62,3 +64,20 @@ def test_unpack_legacy_message():
     assert message.data.decode() == "this is a test message"
     assert message.signature.hex() == "b16847437049986f936dd4a0917c869730cbf29e40a0c0821ca70db33f44758c3d41bcbea446dee70dea13d50942343bb78e74979dc434bbb2b901e0f4fd1809"
     assert message.version == 1
+    assert message.signer == "ErdJS"
+
+
+def test_unpack_message():
+    packed_message = {
+        "address": "erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th",
+        "message": "0x7468697320697320612074657374206d657373616765",
+        "signature": "0xb16847437049986f936dd4a0917c869730cbf29e40a0c0821ca70db33f44758c3d41bcbea446dee70dea13d50942343bb78e74979dc434bbb2b901e0f4fd1809"
+    }
+
+    message = message_computer.unpack_message(packed_message)
+    assert message.address
+    assert message.address.to_bech32() == alice.to_bech32()
+    assert message.data.decode() == "this is a test message"
+    assert message.signature.hex() == "b16847437049986f936dd4a0917c869730cbf29e40a0c0821ca70db33f44758c3d41bcbea446dee70dea13d50942343bb78e74979dc434bbb2b901e0f4fd1809"
+    assert message.version == 1
+    assert message.signer == UNKNOWN_SIGNER