Rename smsg_plaintext_version.

basicswap/basicswap.py

@@ -1151,7 +1151,7 @@ class BasicSwap(BaseApp, BSXNetwork, UIApp):
         # Scan inbox
         # TODO: Redundant? small window for zmq messages to go unnoticed during startup?
         options = {"encoding": "hex"}
-        if self._can_use_smsg_plaintext2:
+        if self._can_use_smsg_payload2:
             options["pubkey_from"] = True
         ro = self.callrpc("smsginbox", ["unread", "", options])
         nm = 0

basicswap/network/bsx_network.py

@@ -70,7 +70,7 @@ class BSXNetwork:
     def __init__(self, data_dir, settings, **kwargs):
         self._bridge_networks = self.settings.get("bridge_networks", False)
         self._use_direct_message_routes = True
-        self._smsg_plaintext_version = self.settings.get("smsg_plaintext_version", 1)
+        self._smsg_payload_version = self.settings.get("smsg_payload_version", 1)
         self._smsg_add_to_outbox = self.settings.get("smsg_add_to_outbox", False)
         self._have_smsg_rpc = False  # Set in startNetworks
 
@@ -136,21 +136,21 @@ class BSXNetwork:
                 have_smsg = True
                 add_network = {"type": "smsg"}
                 if "bridged" in network:
-                    if self._smsg_plaintext_version < 2:
+                    if self._smsg_payload_version < 2:
                         raise ValueError(
-                            'Bridged networks require "smsg_plaintext_version" >= 2'
+                            'Bridged networks require "smsg_payload_version" >= 2'
                         )
                     add_network["bridged"] = network["bridged"]
                 self.active_networks.append(add_network)
             elif network["type"] == "simplex":
                 initialiseSimplexNetwork(self, network)
 
-        self._can_use_smsg_plaintext2 = False
+        self._can_use_smsg_payload2 = False
         if (
             Coins.PART in self.coin_clients
             and self.coin_clients[Coins.PART]["core_version"] > 23020700
         ):
-            self._can_use_smsg_plaintext2 = True
+            self._can_use_smsg_payload2 = True
 
         if have_smsg:
             self._have_smsg_rpc = True
@@ -215,7 +215,7 @@ class BSXNetwork:
 
         # TODO: Ensure smsg is enabled for the active wallet.
 
-        if self._can_use_smsg_plaintext2:
+        if self._can_use_smsg_payload2:
             self.callrpc("smsgoptions", ["set", "addReceivedPubkeys", False])
 
         now: int = self.getTime()
@@ -341,7 +341,7 @@ class BSXNetwork:
         return network["ws_thread"]
 
     def getMessageNetsString(self, with_bridged: bool = False) -> str:
-        if self._smsg_plaintext_version < 2:
+        if self._smsg_payload_version < 2:
             return ""
         active_networks_set = set()
         bridged_networks_set = set()
@@ -363,7 +363,7 @@ class BSXNetwork:
     def selectMessageNetString(
         self, received_on_network_ids, remote_message_nets: str
     ) -> str:
-        if self._smsg_plaintext_version < 2:
+        if self._smsg_payload_version < 2:
             return ""
         active_networks_set = set()
         bridged_networks_set = set()
@@ -566,7 +566,7 @@ class BSXNetwork:
             return message_id
 
         smsg_difficulty: int = 0x1EFFFFFF
-        if self._have_smsg_rpc and self._smsg_plaintext_version >= 2:
+        if self._have_smsg_rpc and self._smsg_payload_version >= 2:
             smsg_difficulty = self.callrpc("smsggetdifficulty", [-1, True])
         else:
             self.log.debug("TODO, get difficulty from a portal")
@@ -592,7 +592,7 @@ class BSXNetwork:
                 if smsg_msg:
                     self.forwardSmsg(smsg_msg)
                 else:
-                    if self._smsg_plaintext_version < 2:
+                    if self._smsg_payload_version < 2:
                         # TODO: Remove when Particl 23.2.8 is min version
                         net_message_id = self.sendSmsg(
                             addr_from,
@@ -704,10 +704,10 @@ class BSXNetwork:
         cursor=None,
     ) -> bytes:
         options = {"decodehex": True, "ttl_is_seconds": True}
-        if self._smsg_plaintext_version >= 2:
-            options["plaintext_format_version"] = 2
+        if self._smsg_payload_version >= 2:
+            options["payload_format_version"] = 2
             options["compression"] = 0
-        if self._can_use_smsg_plaintext2:
+        if self._can_use_smsg_payload2:
             send_to = self.getPubkeyForAddress(cursor, addr_to).hex()
         else:
             send_to = addr_to
@@ -779,7 +779,7 @@ class BSXNetwork:
         self.commitDB()
 
     def getSmsgMsgBytes(self, msg) -> bytes:
-        if int(self._smsg_plaintext_version) < 2:
+        if int(self._smsg_payload_version) < 2:
             return bytes.fromhex(msg["hex"][2:-2])
         return bytes.fromhex(msg["hex"][2:])
 
@@ -789,7 +789,7 @@ class BSXNetwork:
 
         msg_id = message[2:]
         options = {"encoding": "hex", "setread": True}
-        if self._can_use_smsg_plaintext2:
+        if self._can_use_smsg_payload2:
             options["pubkey_from"] = True
         num_tries = 5
         for i in range(num_tries + 1):
@@ -1140,7 +1140,7 @@ class BSXNetwork:
             if now - self._last_checked_smsg >= self.check_smsg_seconds:
                 self._last_checked_smsg = now
                 options = {"encoding": "hex", "setread": True}
-                if self._can_use_smsg_plaintext2:
+                if self._can_use_smsg_payload2:
                     options["pubkey_from"] = True
                 msgs = self.callrpc("smsginbox", ["unread", "", options])
                 for msg in msgs["messages"]:

basicswap/util/smsg.py

@@ -94,7 +94,7 @@ def smsgEncrypt(
     payload: bytes,
     smsg_timestamp: int = None,
     deterministic: bool = False,
-    plaintext_format: int = 2,
+    payload_format: int = 2,
     difficulty_target=0x1EFFFFFF,
 ) -> bytes:
     # assert len(payload) < 128  # Requires lz4 if payload > 128 bytes
@@ -133,11 +133,11 @@ def smsgEncrypt(
 
     len_payload = len(payload)
 
-    if plaintext_format == 2:
+    if payload_format == 2:
         address_version = 249  # Marker for format 2
         compressed = 0
         plaintext_data: bytes = bytes((address_version, compressed))
-    elif plaintext_format == 1:
+    elif payload_format == 1:
         address_version = 0
         plaintext_data: bytes = bytes((address_version,))
     else:

tests/basicswap/extended/test_multinet.py

@@ -73,7 +73,7 @@ class Test(TestSimplex2):
     @classmethod
     def addCoinSettings(cls, settings, datadir, node_id):
         settings["networks"] = []
-        settings["smsg_plaintext_version"] = 2
+        settings["smsg_payload_version"] = 2
         if node_id in (0, 2):
             settings["networks"].append(
                 {

tests/basicswap/extended/test_simplex.py

@@ -457,7 +457,7 @@ class TestSimplex2(BaseTest):
 
     @classmethod
     def addCoinSettings(cls, settings, datadir, node_id):
-        settings["smsg_plaintext_version"] = 2
+        settings["smsg_payload_version"] = 2
         settings["networks"] = [
             {
                 "type": "simplex",

tests/basicswap/extended/test_smsg.py

@@ -147,7 +147,7 @@ class Test(BaseTest):
         rv = ci1_part.rpc("smsgimport", [encrypted_message.hex(), {"submitmsg": True}])
         assert rv["msgid"] == msg_id.hex()
 
-    def test_02_plaintext_v2(self):
+    def test_02_payload_v2(self):
         # Test SMSG plaintext version 2
 
         ci0_part = self.swap_clients[0].ci(Coins.PART)
@@ -174,7 +174,7 @@ class Test(BaseTest):
         options = {
             "submitmsg": False,
             "ttl_is_seconds": True,
-            "plaintext_format_version": 2,
+            "payload_format_version": 2,
             "compression": 0,
             "add_to_outbox": False,
         }