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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: symbol-sdk-python
-Version: 3.2.0
+Version: 3.2.3
 Summary: Symbol SDK
 Home-page: https://github.com/symbol/symbol/tree/main/sdk/python
 License: MIT
@@ -9,19 +9,19 @@ Author: Symbol Contributors
 Author-email: contributors@symbol.dev
 Maintainer: Symbol Contributors
 Maintainer-email: contributors@symbol.dev
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9.2,<4.0.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: cryptography (>=42.0.2,<42.1.0)
+Classifier: Programming Language :: Python :: 3.9
+Requires-Dist: cryptography (>=44.0.0,<44.1.0)
 Requires-Dist: mnemonic (>=0.20,<1.0)
-Requires-Dist: pillow (>=10.3.0,<10.4.0)
+Requires-Dist: pillow (>=11.0.0,<11.1.0)
 Requires-Dist: pynacl (>=1.5.0,<1.6.0)
 Requires-Dist: pyyaml (>=6.0.1,<6.1.0)
 Requires-Dist: pyzbar (>=0.1.9,<0.2.0)
-Requires-Dist: qrcode (>=7.4.2,<7.5.0)
+Requires-Dist: qrcode (>=8.0,<9.0)
 Requires-Dist: ripemd-hash (>=1.0.1,<1.1.0)
 Requires-Dist: safe-pysha3 (>=1.0.4,<1.1.0)
 Project-URL: Repository, https://github.com/symbol/symbol/tree/main/sdk/python

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

@@ -1,16 +1,16 @@
 symbolchain/AccountDescriptorRepository.py,sha256=XCIIt6XvxqClQL0R7_-xyFBhb0q9bIUbNTr5-YS5f1o,2508
 symbolchain/ArrayHelpers.py,sha256=Iu5QqlWW5j_6Qd0oTFO41MfDH_mKwQLT7XeD2frU2mw,3728
-symbolchain/BaseValue.py,sha256=AGtUYscbQk-w_rGbd9SS2gh3vnTYhCCwpXBt-9bA4u0,1482
+symbolchain/BaseValue.py,sha256=vc56rclpJtxYIL6Mvo6KWwnA0pUfhtsB71NSEjobQtc,1636
 symbolchain/Bip32.py,sha256=L8Fs0XTERGWSPX972KUn-AOPwAS2gZMdVTKAq4HOGa8,1787
 symbolchain/BlockchainSettings.py,sha256=uRHHxi0gW_U9LFUhoDpNMTe2CobLNJQwE9ZMy2o1aX8,723
 symbolchain/BufferReader.py,sha256=Bcg59ZkUzhgKIo2-B1q7jwtU5x-W5_TuuaOqPnXM1ug,883
 symbolchain/BufferWriter.py,sha256=JpZkzcxUbbDkGU4Sz-oMhL6dgZ_ovhBVduVB51PEWa4,639
-symbolchain/ByteArray.py,sha256=u5FyC6tSxWLXDpT-_Pd3fIYftde1aAK1x5dikROJ0-0,1059
+symbolchain/ByteArray.py,sha256=fVII_BDew55qTU0dQIZWYvWWT_vxfCW_IJzcPglCHr8,1173
 symbolchain/Cipher.py,sha256=CtNKjLJJPTTI4TV4Q_-bkloGSr20wjzHmaLMAbKp03g,2158
 symbolchain/CodeWordsEncoder.py,sha256=YydhdbhxTvjXYUp1OkJj7XjTz3WfKVSGi8VIUzGTTHA,1233
 symbolchain/CryptoTypes.py,sha256=9rMQyYF0xBU5W1vo07fgDqfP4dR3E_Hv5Ec1ozKanUs,1844
 symbolchain/DiceMnemonicGenerator.py,sha256=F8QU90PQzp-qzNqnnxHowVtG_-rNiqWDALSsi-8I_og,1848
-symbolchain/Network.py,sha256=LCMIkYo5yTlV-8_gqIjOZTSGeCBJuBZ7YisJJ1G36z4,3368
+symbolchain/Network.py,sha256=6FK2qOGYsGz7qMEpu7hCcvjvnl6tQKjdMTVx9PwTjOI,3398
 symbolchain/NetworkTimestamp.py,sha256=M3T2HFYJT5v9B_tkGn2FkjW6C9hueXmdTjyWWSr9rXw,1595
 symbolchain/NodeDescriptorRepository.py,sha256=DVqhj_D6KWgaYiJC3jKv2ne-AJTvpJrKruhiRmGgtQE,1019
 symbolchain/Ordered.py,sha256=--tQ_aZpXhZYcsRLgMjUNHPYlAH7BMfuss2CSxMvNhY,397
@@ -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=qCaFie17Q1R4wRQqiedKEywJH8yq_CjY_-b9dLgiZQk,4226
+symbolchain/facade/SymbolFacade.py,sha256=YH1WHfZUKZpX2lkHauRe1Kbnyvf1CJbwfLJPV73Vntc,6996
 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/nc/__init__.py,sha256=ROTctT787pDzqlnJkavy5vAmVe_JLUwj5e9GprFklXM,121192
 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/sc/__init__.py,sha256=axRbsZf_j33DLTJ2TvIKg6aAxVG5xo1I2w51lzO2h9M,286967
+symbolchain/ripemd160.py,sha256=u2uv8wJY5FY8tll_EfiGE5o65Ri6E-8HbynvJUPBJa8,429
+symbolchain/sc/__init__.py,sha256=7LmLmA9UxXcwPHIerp8YjUoTplHAUjV1vtEqx007adc,309662
 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.3.dist-info/METADATA,sha256=E-Q5OZVVupO5MjneN1tpBwQ0OUTAcj7JOY4tdb65Ujk,5584
+symbol_sdk_python-3.2.3.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+symbol_sdk_python-3.2.3.dist-info/RECORD,,

symbolchain/BaseValue.py

@@ -49,3 +49,7 @@ class BaseValue(Ordered):
 			unsigned_value = self.value + upper_bound_plus_one
 
 		return f'0x{unsigned_value:0{self.size * 2}X}'
+
+	def to_json(self):
+		"""Returns representation of this object that can be stored in JSON."""
+		return str(self.value) if 8 <= self.size else self.value

symbolchain/ByteArray.py

@@ -37,3 +37,7 @@ class ByteArray(Ordered):
 
 	def __str__(self):
 		return hexlify(self.bytes).decode('utf8').upper()
+
+	def to_json(self):
+		"""Returns representation of this object that can be stored in JSON."""
+		return str(self)

symbolchain/Network.py

@@ -9,7 +9,7 @@ class Network:
 	"""Represents a network."""
 
 	def __init__(self, name, identifier, datetime_converter, address_class, network_timestamp_class):
-		# pylint: disable=too-many-arguments
+		# pylint: disable=too-many-arguments,too-many-positional-arguments
 
 		"""Creates a new network with the specified properties."""
 		self.name = name

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."""
@@ -53,16 +93,18 @@ class NemFacade:
 		return Hash256(sha3.keccak_256(non_verifiable_transaction.serialize()).digest())
 
 	@staticmethod
-	def sign_transaction(key_pair, transaction):
-		"""Signs a NEM transaction."""
+	def extract_signing_payload(transaction):
+		"""Gets the payload to sign given a NEM transaction."""
 		non_verifiable_transaction = TransactionFactory.to_non_verifiable_transaction(transaction)
-		return key_pair.sign(non_verifiable_transaction.serialize())
+		return non_verifiable_transaction.serialize()
 
-	@staticmethod
-	def verify_transaction(transaction, signature):
+	def sign_transaction(self, key_pair, transaction):
+		"""Signs a NEM transaction."""
+		return key_pair.sign(self.extract_signing_payload(transaction))
+
+	def verify_transaction(self, transaction, signature):
 		"""Verifies a NEM transaction."""
-		non_verifiable_transaction = TransactionFactory.to_non_verifiable_transaction(transaction)
-		return Verifier(transaction.signer_public_key).verify(non_verifiable_transaction.serialize(), signature)
+		return Verifier(transaction.signer_public_key).verify(self.extract_signing_payload(transaction), signature)
 
 	def bip32_path(self, account_id):
 		"""Creates a network compatible BIP32 path for the specified account."""

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,45 @@ 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)
+
+	def cosign_transaction_hash(self, transaction_hash, detached=False):
+		"""Cosigns a Symbol transaction hash."""
+		return self._facade.cosign_transaction_hash(self.key_pair, transaction_hash, detached)
+
+# endregion
+
+
 class SymbolFacade:
 	"""Facade used to interact with Symbol blockchain."""
 
@@ -63,6 +103,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()
@@ -72,22 +120,23 @@ class SymbolFacade:
 		hasher.update(self._transaction_data_buffer(transaction.serialize()))
 		return Hash256(hasher.digest())
 
-	def sign_transaction(self, key_pair, transaction):
-		"""Signs a Symbol transaction."""
+	def extract_signing_payload(self, transaction):
+		"""Gets the payload to sign given a Symbol transaction."""
 		sign_buffer = self.network.generation_hash_seed.bytes
 		sign_buffer += self._transaction_data_buffer(transaction.serialize())
-		return key_pair.sign(sign_buffer)
+		return sign_buffer
+
+	def sign_transaction(self, key_pair, transaction):
+		"""Signs a Symbol transaction."""
+		return key_pair.sign(self.extract_signing_payload(transaction))
 
 	def verify_transaction(self, transaction, signature):
 		"""Verifies a Symbol transaction."""
-		verify_buffer = self.network.generation_hash_seed.bytes
-		verify_buffer += self._transaction_data_buffer(transaction.serialize())
-		return Verifier(transaction.signer_public_key).verify(verify_buffer, signature)
-
-	def cosign_transaction(self, key_pair, transaction, detached=False):
-		"""Cosigns a Symbol transaction."""
-		transaction_hash = self.hash_transaction(transaction)
+		return Verifier(transaction.signer_public_key).verify(self.extract_signing_payload(transaction), signature)
 
+	@staticmethod
+	def cosign_transaction_hash(key_pair, transaction_hash, detached=False):
+		"""Cosigns a Symbol transaction hash."""
 		cosignature = sc.DetachedCosignature() if detached else sc.Cosignature()
 		if detached:
 			cosignature.parent_hash = sc.Hash256(transaction_hash.bytes)
@@ -97,6 +146,11 @@ class SymbolFacade:
 		cosignature.signature = sc.Signature(key_pair.sign(transaction_hash.bytes).bytes)
 		return cosignature
 
+	def cosign_transaction(self, key_pair, transaction, detached=False):
+		"""Cosigns a Symbol transaction."""
+		transaction_hash = self.hash_transaction(transaction)
+		return self.cosign_transaction_hash(key_pair, transaction_hash, detached)
+
 	@staticmethod
 	def hash_embedded_transactions(embedded_transactions):
 		"""Hashes embedded transactions of an aggregate."""