symbol-sdk-python 3.2.0__py3-none-any.whl → 3.2.2__py3-none-any.whl

{symbol_sdk_python-3.2.0.dist-info → symbol_sdk_python-3.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: symbol-sdk-python
-Version: 3.2.0
+Version: 3.2.2
 Summary: Symbol SDK
 Home-page: https://github.com/symbol/symbol/tree/main/sdk/python
 License: MIT

{symbol_sdk_python-3.2.0.dist-info → symbol_sdk_python-3.2.2.dist-info}/RECORD

@@ -25,30 +25,30 @@ symbolchain/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 symbolchain/external/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 symbolchain/external/ed25519.py,sha256=xpq-UOQ3CNCZp4V2uaHsWeyEfXezCfWe44NKsecZCqU,7833
 symbolchain/facade/BatchOperations.py,sha256=SQR6fXTi1mI7H7ubJsqYEabWQzzVXhbD8BkzgIpoCII,2983
-symbolchain/facade/NemFacade.py,sha256=z8gSD6zAj0UmQunDbKv87yTbVe5WOwxM1UVlqwq6Yh4,2990
-symbolchain/facade/SymbolFacade.py,sha256=AtebZnCu0Ui5JGLGLT3cPQTXyN1idYRz4t9JZsT7sTI,5128
+symbolchain/facade/NemFacade.py,sha256=oOvU8hJRNjZAFaoETueyw_R0K-S6AvlNV3pB7ltVOfY,4166
+symbolchain/facade/SymbolFacade.py,sha256=Yz7hIGanNY8iFLeIelRB8-M44gmlvbdc0pB_ouGkNg0,6527
 symbolchain/facade/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 symbolchain/impl/CipherHelpers.py,sha256=KSYH95oie-PxFfGAYfnqHOC1RWIrdxC7Vp6Go-o469Q,2152
 symbolchain/impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 symbolchain/nc/__init__.py,sha256=vosYIQt3McpoGpspAl3YoV3_vrpNO-ddiTDmyqk0u-c,106403
 symbolchain/nem/KeyPair.py,sha256=34VwU7EdroB0nnzTCdTEUAK_DMrcDYzo3JKdniXQMG4,3712
-symbolchain/nem/MessageEncoder.py,sha256=U8-X7MczTj-XRvCx1YHXmK389oyf0OLAu7WEBf3gpfc,2583
+symbolchain/nem/MessageEncoder.py,sha256=EGm4mtmyXUXQb-R49Xmrl3w40ye_LbZQ8r5aJusH0WE,2699
 symbolchain/nem/Network.py,sha256=vD7YEqJHyUPK14UAGBT29cX9Cjvq1uHDfeiYudaxgAw,1746
 symbolchain/nem/SharedKey.py,sha256=owBUV_XNo1wCby0b4Amz1Bl6uzTeQmiSFy7UcWFo00I,1094
-symbolchain/nem/TransactionFactory.py,sha256=k-qyXHa7lL9jrfNrtXCrRVzl2Qv3BuMoTXU7AKYvQow,4017
+symbolchain/nem/TransactionFactory.py,sha256=IaKsLdTmW8ZU9s5kaUcaGl7P91awR8BMDfX_zWTAO04,4170
 symbolchain/nem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-symbolchain/ripemd160.py,sha256=rq9A2ohillUGcxM4x31eFxXcfLUi-O3sHK8ff4j1XAI,378
+symbolchain/ripemd160.py,sha256=u2uv8wJY5FY8tll_EfiGE5o65Ri6E-8HbynvJUPBJa8,429
 symbolchain/sc/__init__.py,sha256=axRbsZf_j33DLTJ2TvIKg6aAxVG5xo1I2w51lzO2h9M,286967
 symbolchain/symbol/IdGenerator.py,sha256=4CWW5EekbmULDDukscs73ZFN_U179hAacK3luL7Q0TA,1696
 symbolchain/symbol/KeyPair.py,sha256=CkQh7oOeVRbjKewTfln0t1PZckcTuIXb2roY1zZjVrc,1506
 symbolchain/symbol/Merkle.py,sha256=FrCwnveXEoXEx7xFP4UC_htjAVuVeUNbvnh8YDdy3z0,7243
-symbolchain/symbol/MessageEncoder.py,sha256=A2KX8MxhCMYaxnEnKY0HyVGgB9cjAUiF3FMgDWfXMxk,3766
-symbolchain/symbol/Metadata.py,sha256=pBpBo0XmC4I7cjBqGVtdu2Blpey32l_1dZyTYsbmMyA,567
-symbolchain/symbol/Network.py,sha256=fKYKYl9gm3cRUcTJA7LxxT3LGQgxb_TUNDVH8rRHR_c,2229
+symbolchain/symbol/MessageEncoder.py,sha256=X4io7OTEJOgy9LtDCzInm4QQFVbNWpkJnba6-S5vrkI,3882
+symbolchain/symbol/Metadata.py,sha256=8DpgwTFy8IYxjNRmT_NBSn3WBhU9z2xlWvsMIh7GgwU,884
+symbolchain/symbol/Network.py,sha256=CFFEFEByLDF-KFD2As5dgj-1MIuKmec5T_yfoxNDHkQ,2933
 symbolchain/symbol/SharedKey.py,sha256=Bg1qYW_iMNYKtokep5S1m9b7GfywM5OGaCrVUdt01JU,334
-symbolchain/symbol/TransactionFactory.py,sha256=HB7rTP57kFlxj8tWZRSChhKh6UN8IUDATdiCtRwGMYQ,3624
+symbolchain/symbol/TransactionFactory.py,sha256=65N6UHDwrzNyHnpxkw-RmjuC32Znto1B9TH5OgcD1Oo,3957
 symbolchain/symbol/VotingKeysGenerator.py,sha256=tuJ6yl2CqqQ9uupAw3z-GJIW20WOsblcLQb2_fPUCDE,1686
 symbolchain/symbol/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-symbol_sdk_python-3.2.0.dist-info/METADATA,sha256=GEDOnkuxcdwWMYkh_9DP6Ujk-YnEZfnMb91HtrOFKs4,5584
-symbol_sdk_python-3.2.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-symbol_sdk_python-3.2.0.dist-info/RECORD,,
+symbol_sdk_python-3.2.2.dist-info/METADATA,sha256=H3eZti6Yn4oq90_uE111bCzAPZkgrfnU2VWN9f1Spzg,5584
+symbol_sdk_python-3.2.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+symbol_sdk_python-3.2.2.dist-info/RECORD,,

symbolchain/facade/NemFacade.py

@@ -4,11 +4,43 @@ import sha3
 
 from ..CryptoTypes import Hash256, PrivateKey, PublicKey
 from ..nem.KeyPair import KeyPair, Verifier
+from ..nem.MessageEncoder import MessageEncoder
 from ..nem.Network import Address, Network
 from ..nem.SharedKey import SharedKey
 from ..nem.TransactionFactory import TransactionFactory
 from ..Network import NetworkLocator
 
+# region NemPublicAccount / NemAccount
+
+
+class NemPublicAccount:
+	"""NEM public account."""
+
+	def __init__(self, facade, public_key):
+		"""Creates a NEM public account."""
+		self._facade = facade
+		self.public_key = public_key
+		self.address = self._facade.network.public_key_to_address(self.public_key)
+
+
+class NemAccount(NemPublicAccount):
+	"""NEM account."""
+
+	def __init__(self, facade, key_pair):
+		"""Creates a NEM account."""
+		super().__init__(facade, key_pair.public_key)
+		self.key_pair = key_pair
+
+	def message_encoder(self):
+		"""Creates a message encoder that can be used for encrypting and encoding messages between two parties."""
+		return MessageEncoder(self.key_pair)
+
+	def sign_transaction(self, transaction):
+		"""Signs a NEM transaction."""
+		return self._facade.sign_transaction(self.key_pair, transaction)
+
+# endregion
+
 
 class NemFacade:
 	"""Facade used to interact with NEM blockchain."""
@@ -46,6 +78,14 @@ class NemFacade:
 		"""Creates a network timestamp representing the current time."""
 		return self.network.from_datetime(datetime.now(timezone.utc))
 
+	def create_public_account(self, public_key):
+		"""Creates a NEM public account from a public key."""
+		return NemPublicAccount(self, public_key)
+
+	def create_account(self, private_key):
+		"""Creates a NEM account from a private key."""
+		return NemAccount(self, KeyPair(private_key))
+
 	@staticmethod
 	def hash_transaction(transaction):
 		"""Hashes a NEM transaction."""

symbolchain/facade/SymbolFacade.py

@@ -6,6 +6,7 @@ from ..CryptoTypes import Hash256, PublicKey, Signature
 from ..Network import NetworkLocator
 from ..symbol.KeyPair import KeyPair, Verifier
 from ..symbol.Merkle import MerkleHashBuilder
+from ..symbol.MessageEncoder import MessageEncoder
 from ..symbol.Network import Address, Network
 from ..symbol.SharedKey import SharedKey
 from ..symbol.TransactionFactory import TransactionFactory
@@ -26,6 +27,41 @@ AGGREGATE_HASHED_SIZE = sum(field[1] for field in [
 ])
 
 
+# region SymbolPublicAccount / SymbolAccount
+
+class SymbolPublicAccount:
+	"""Symbol public account."""
+
+	def __init__(self, facade, public_key):
+		"""Creates a Symbol public account."""
+		self._facade = facade
+		self.public_key = public_key
+		self.address = self._facade.network.public_key_to_address(self.public_key)
+
+
+class SymbolAccount(SymbolPublicAccount):
+	"""Symbol account."""
+
+	def __init__(self, facade, key_pair):
+		"""Creates a Symbol account."""
+		super().__init__(facade, key_pair.public_key)
+		self.key_pair = key_pair
+
+	def message_encoder(self):
+		"""Creates a message encoder that can be used for encrypting and encoding messages between two parties."""
+		return MessageEncoder(self.key_pair)
+
+	def sign_transaction(self, transaction):
+		"""Signs a Symbol transaction."""
+		return self._facade.sign_transaction(self.key_pair, transaction)
+
+	def cosign_transaction(self, transaction, detached=False):
+		"""Cosigns a Symbol transaction."""
+		return self._facade.cosign_transaction(self.key_pair, transaction, detached)
+
+# endregion
+
+
 class SymbolFacade:
 	"""Facade used to interact with Symbol blockchain."""
 
@@ -63,6 +99,14 @@ class SymbolFacade:
 		"""Creates a network timestamp representing the current time."""
 		return self.network.from_datetime(datetime.now(timezone.utc))
 
+	def create_public_account(self, public_key):
+		"""Creates a Symbol public account from a public key."""
+		return SymbolPublicAccount(self, public_key)
+
+	def create_account(self, private_key):
+		"""Creates a Symbol account from a private key."""
+		return SymbolAccount(self, KeyPair(private_key))
+
 	def hash_transaction(self, transaction):
 		"""Hashes a Symbol transaction."""
 		hasher = hashlib.sha3_256()

symbolchain/nem/MessageEncoder.py

@@ -17,6 +17,12 @@ class MessageEncoder:
 
 		self.key_pair = key_pair
 
+	@property
+	def public_key(self):
+		"""Public key used for message encoding."""
+
+		return self.key_pair.public_key
+
 	def try_decode(self, recipient_public_key, encoded_message: Message):
 		"""Tries to decode encoded message, returns tuple:
 		* True, message - if message has been decoded and decrypted

symbolchain/nem/TransactionFactory.py

@@ -39,6 +39,11 @@ class TransactionFactory:
 
 		return transaction
 
+	@staticmethod
+	def deserialize(payload):
+		"""Deserializes a transaction from a binary payload."""
+		return nc.TransactionFactory.deserialize(payload)
+
 	@staticmethod
 	def to_non_verifiable_transaction(transaction):
 		"""Converts a transaction to a non-verifiable transaction."""

symbolchain/ripemd160.py

@@ -5,6 +5,7 @@ if 'ripemd160' not in hashlib.algorithms_guaranteed:
 
 
 def _factory():
+	# pylint: disable=possibly-used-before-assignment
 	return hashlib.new('ripemd160') if 'ripemd160' in hashlib.algorithms_guaranteed else ripemd160_impl.new()
 
 

symbolchain/symbol/MessageEncoder.py

@@ -20,6 +20,12 @@ class MessageEncoder:
 
 		self.key_pair = key_pair
 
+	@property
+	def public_key(self):
+		"""Public key used for message encoding."""
+
+		return self.key_pair.public_key
+
 	def try_decode(self, recipient_public_key, encoded_message):
 		"""Tries to decode encoded message, returns tuple:
 		* True, message - if message has been decoded and decrypted

symbolchain/symbol/Metadata.py

@@ -1,3 +1,17 @@
+import hashlib
+
+
+def metadata_generate_key(seed):
+	"""Generates a metadata key from a string."""
+
+	hash_result = hashlib.sha3_256(seed.encode('utf8')).digest()
+
+	key_bytes = bytearray(hash_result[:8])
+	key_bytes[7] |= 0x80  # set high bit to match SDK V2 implementation
+
+	return int.from_bytes(key_bytes, 'little')
+
+
 def metadata_update_value(old_value, new_value):
 	"""Creates a metadata payload for updating old value to new value."""
 

symbolchain/symbol/Network.py

@@ -1,12 +1,14 @@
 import base64
 import datetime
 import hashlib
+from binascii import unhexlify
 
 from ..ByteArray import ByteArray
 from ..CryptoTypes import Hash256
 from ..Network import Network as BasicNetwork
 from ..NetworkTimestamp import NetworkTimestamp as BasicNetworkTimestamp
 from ..NetworkTimestamp import NetworkTimestampDatetimeConverter
+from ..sc import NamespaceId
 
 
 class NetworkTimestamp(BasicNetworkTimestamp):
@@ -36,12 +38,32 @@ class Address(ByteArray):
 
 		super().__init__(self.SIZE, raw_bytes, Address)
 
+	def to_namespace_id(self):
+		"""Attempts to convert this address into a namespace id."""
+
+		if not self.bytes[0] & 0x01:
+			return None
+
+		return NamespaceId(int.from_bytes(self.bytes[1:9], 'little'))
+
 	def __str__(self):
 		return base64.b32encode(self.bytes + bytes(0)).decode('utf8')[0:-1]
 
 	def __repr__(self):
 		return f'Address(\'{str(self)}\')'
 
+	@staticmethod
+	def from_decoded_address_hex_string(hex_string):
+		"""Creates an address from a decoded address hex string (typically from REST)."""
+
+		return Address(unhexlify(hex_string))
+
+	@staticmethod
+	def from_namespace_id(namespace_id, network_identifier):
+		"""Creates an address from a namespace id."""
+
+		return Address(bytes([network_identifier + 1]) + namespace_id.value.to_bytes(8, 'little') + bytes([0] * (Address.SIZE - 9)))
+
 
 class Network(BasicNetwork):
 	"""Represents a Symbol network."""

symbolchain/symbol/TransactionFactory.py

@@ -55,6 +55,16 @@ class TransactionFactory:
 		"""
 		return self._create_and_extend(transaction_descriptor, autosort, sc.EmbeddedTransactionFactory)
 
+	@staticmethod
+	def deserialize(payload):
+		"""Deserializes a transaction from a binary payload."""
+		return sc.TransactionFactory.deserialize(payload)
+
+	@staticmethod
+	def deserialize_embedded(payload):
+		"""Deserializes an embedded transaction from a binary payload."""
+		return sc.EmbeddedTransactionFactory.deserialize(payload)
+
 	@staticmethod
 	def attach_signature(transaction, signature):
 		"""Attaches a signature to a transaction."""