Drop 'transaction' word from sign methods in Account class (#1278)

Author: ddoktorski

docs/migration_guide.rst

@@ -17,8 +17,8 @@ Changes in the :class:`~starknet_py.net.account.account.Account`:
 .. currentmodule:: starknet_py.net.account.account
 
 - :meth:`~Account.execute_v3` has been added.
-- :meth:`~Account.sign_declare_v3_transaction`, :meth:`~Account.sign_deploy_account_v3_transaction` and :meth:`~Account.sign_invoke_v3_transaction` have been added.
-- :meth:`~Account.sign_declare_transaction`, :meth:`~Account.sign_deploy_account_transaction` and :meth:`~Account.sign_invoke_transaction` have been renamed to :meth:`~Account.sign_declare_v1_transaction`, :meth:`~Account.sign_deploy_account_v1_transaction` and :meth:`~Account.sign_invoke_v1_transaction` respectively.
+- :meth:`~Account.sign_declare_v3`, :meth:`~Account.sign_deploy_account_v3` and :meth:`~Account.sign_invoke_v3` have been added.
+- :meth:`sign_declare_transaction`, :meth:`sign_declare_v2_transaction`, :meth:`sign_deploy_account_transaction` and :meth:`sign_invoke_transaction` have been renamed to :meth:`~Account.sign_declare_v1`, :meth:`~Account.sign_declare_v2`, :meth:`~Account.sign_deploy_account_v1` and :meth:`~Account.sign_invoke_v1` respectively.
 
 All new functions with ``v3`` in their name operate similarly to their ``v1`` and ``v2`` counterparts.
 Unlike their ``v1`` counterparts, ``v3`` transaction fees are paid in Fri (10^-18 STRK). Therefore,  ``max_fee`` parameter, which is typically set in Wei, is not applicable for ``v3`` functions. Instead, ``l1_resource_bounds`` parameter is utilized to limit the Fri amount used.
@@ -351,7 +351,7 @@ Also, four methods were added to its interface:
 
 .. currentmodule:: starknet_py.net.account.account
 
-2. :meth:`Account.sign_invoke_transaction`, :meth:`Account.sign_declare_transaction`, :meth:`Account.sign_declare_v2_transaction`, :meth:`Account.sign_deploy_account_transaction` and :meth:`Account.execute` can now accept custom ``nonce`` parameter.
+2. :meth:`Account.sign_invoke_transaction`, :meth:`Account.sign_declare_transaction`, :meth:`Account.sign_declare_v2`, :meth:`Account.sign_deploy_account_transaction` and :meth:`Account.execute` can now accept custom ``nonce`` parameter.
 3. :meth:`Account.get_nonce` can now be parametrized with ``block_number`` or ``block_hash``.
 4. :meth:`Account.get_balance` can now be parametrized with ``block_number`` or ``block_hash``.
 

starknet_py/contract.py

@@ -429,7 +429,7 @@ async def invoke(
         :return: InvokeResult.
         """
 
-        transaction = await self.get_account.sign_invoke_v1_transaction(
+        transaction = await self.get_account.sign_invoke_v1(
             calls=self,
             nonce=nonce,
             max_fee=max_fee or self.max_fee,
@@ -445,9 +445,7 @@ async def estimate_fee(
         *,
         nonce: Optional[int] = None,
     ) -> EstimatedFee:
-        tx = await self.get_account.sign_invoke_v1_transaction(
-            calls=self, nonce=nonce, max_fee=0
-        )
+        tx = await self.get_account.sign_invoke_v1(calls=self, nonce=nonce, max_fee=0)
         estimate_tx = await self.get_account.sign_for_fee_estimate(transaction=tx)
 
         estimated_fee = await self._client.estimate_fee(
@@ -486,7 +484,7 @@ async def invoke(
         :return: InvokeResult.
         """
 
-        transaction = await self.get_account.sign_invoke_v3_transaction(
+        transaction = await self.get_account.sign_invoke_v3(
             calls=self,
             nonce=nonce,
             l1_resource_bounds=l1_resource_bounds or self.l1_resource_bounds,
@@ -502,7 +500,7 @@ async def estimate_fee(
         *,
         nonce: Optional[int] = None,
     ) -> EstimatedFee:
-        tx = await self.get_account.sign_invoke_v3_transaction(
+        tx = await self.get_account.sign_invoke_v3(
             calls=self, nonce=nonce, l1_resource_bounds=ResourceBounds.init_with_zeros()
         )
         estimate_tx = await self.get_account.sign_for_fee_estimate(transaction=tx)
@@ -831,7 +829,7 @@ async def declare_v1(
         :return: DeclareResult instance.
         """
 
-        declare_tx = await account.sign_declare_v1_transaction(
+        declare_tx = await account.sign_declare_v1(
             compiled_contract=compiled_contract,
             nonce=nonce,
             max_fee=max_fee,
@@ -871,7 +869,7 @@ async def declare_v2(
             compiled_contract_casm, compiled_class_hash
         )
 
-        declare_tx = await account.sign_declare_v2_transaction(
+        declare_tx = await account.sign_declare_v2(
             compiled_contract=compiled_contract,
             compiled_class_hash=compiled_class_hash,
             nonce=nonce,
@@ -913,7 +911,7 @@ async def declare_v3(
             compiled_contract_casm, compiled_class_hash
         )
 
-        declare_tx = await account.sign_declare_v3_transaction(
+        declare_tx = await account.sign_declare_v3(
             compiled_contract=compiled_contract,
             compiled_class_hash=compiled_class_hash,
             nonce=nonce,

starknet_py/net/account/account.py

@@ -318,7 +318,7 @@ async def sign_for_fee_estimate(
         signature = self.signer.sign_transaction(transaction)
         return _add_signature_to_transaction(tx=transaction, signature=signature)
 
-    async def sign_invoke_v1_transaction(
+    async def sign_invoke_v1(
         self,
         calls: Calls,
         *,
@@ -335,7 +335,7 @@ async def sign_invoke_v1_transaction(
         signature = self.signer.sign_transaction(execute_tx)
         return _add_signature_to_transaction(execute_tx, signature)
 
-    async def sign_invoke_v3_transaction(
+    async def sign_invoke_v3(
         self,
         calls: Calls,
         *,
@@ -352,7 +352,7 @@ async def sign_invoke_v3_transaction(
         signature = self.signer.sign_transaction(invoke_tx)
         return _add_signature_to_transaction(invoke_tx, signature)
 
-    async def sign_declare_v1_transaction(
+    async def sign_declare_v1(
         self,
         compiled_contract: str,
         *,
@@ -362,7 +362,7 @@ async def sign_declare_v1_transaction(
     ) -> DeclareV1:
         if _is_sierra_contract(json.loads(compiled_contract)):
             raise ValueError(
-                "Signing sierra contracts requires using `sign_declare_v2_transaction` method."
+                "Signing sierra contracts requires using `sign_declare_v2` method."
             )
 
         declare_tx = await self._make_declare_v1_transaction(
@@ -376,7 +376,7 @@ async def sign_declare_v1_transaction(
         signature = self.signer.sign_transaction(declare_tx)
         return _add_signature_to_transaction(declare_tx, signature)
 
-    async def sign_declare_v2_transaction(
+    async def sign_declare_v2(
         self,
         compiled_contract: str,
         compiled_class_hash: int,
@@ -395,7 +395,7 @@ async def sign_declare_v2_transaction(
         signature = self.signer.sign_transaction(declare_tx)
         return _add_signature_to_transaction(declare_tx, signature)
 
-    async def sign_declare_v3_transaction(
+    async def sign_declare_v3(
         self,
         compiled_contract: str,
         compiled_class_hash: int,
@@ -485,7 +485,7 @@ async def _make_declare_v3_transaction(
         )
         return declare_tx
 
-    async def sign_deploy_account_v1_transaction(
+    async def sign_deploy_account_v1(
         self,
         class_hash: int,
         contract_address_salt: int,
@@ -513,7 +513,7 @@ async def sign_deploy_account_v1_transaction(
         signature = self.signer.sign_transaction(deploy_account_tx)
         return _add_signature_to_transaction(deploy_account_tx, signature)
 
-    async def sign_deploy_account_v3_transaction(
+    async def sign_deploy_account_v3(
         self,
         class_hash: int,
         contract_address_salt: int,
@@ -551,7 +551,7 @@ async def execute_v1(
         max_fee: Optional[int] = None,
         auto_estimate: bool = False,
     ) -> SentTransactionResponse:
-        execute_transaction = await self.sign_invoke_v1_transaction(
+        execute_transaction = await self.sign_invoke_v1(
             calls,
             nonce=nonce,
             max_fee=max_fee,
@@ -567,7 +567,7 @@ async def execute_v3(
         nonce: Optional[int] = None,
         auto_estimate: bool = False,
     ) -> SentTransactionResponse:
-        execute_transaction = await self.sign_invoke_v3_transaction(
+        execute_transaction = await self.sign_invoke_v3(
             calls,
             l1_resource_bounds=l1_resource_bounds,
             nonce=nonce,
@@ -637,7 +637,7 @@ async def deploy_account_v1(
             calldata=calldata,
         )
 
-        deploy_account_tx = await account.sign_deploy_account_v1_transaction(
+        deploy_account_tx = await account.sign_deploy_account_v1(
             class_hash=class_hash,
             contract_address_salt=salt,
             constructor_calldata=calldata,
@@ -710,7 +710,7 @@ async def deploy_account_v3(
             calldata=calldata,
         )
 
-        deploy_account_tx = await account.sign_deploy_account_v3_transaction(
+        deploy_account_tx = await account.sign_deploy_account_v3(
             class_hash=class_hash,
             contract_address_salt=salt,
             constructor_calldata=calldata,

starknet_py/net/account/base_account.py

@@ -101,7 +101,7 @@ async def sign_for_fee_estimate(
         """
 
     @abstractmethod
-    async def sign_invoke_v1_transaction(
+    async def sign_invoke_v1(
         self,
         calls: Calls,
         *,
@@ -120,7 +120,7 @@ async def sign_invoke_v1_transaction(
         """
 
     @abstractmethod
-    async def sign_invoke_v3_transaction(
+    async def sign_invoke_v3(
         self,
         calls: Calls,
         *,
@@ -139,7 +139,7 @@ async def sign_invoke_v3_transaction(
         """
 
     @abstractmethod
-    async def sign_declare_v1_transaction(
+    async def sign_declare_v1(
         self,
         compiled_contract: str,
         *,
@@ -158,7 +158,7 @@ async def sign_declare_v1_transaction(
         """
 
     @abstractmethod
-    async def sign_declare_v2_transaction(
+    async def sign_declare_v2(
         self,
         compiled_contract: str,
         compiled_class_hash: int,
@@ -181,7 +181,7 @@ async def sign_declare_v2_transaction(
         """
 
     @abstractmethod
-    async def sign_declare_v3_transaction(
+    async def sign_declare_v3(
         self,
         compiled_contract: str,
         compiled_class_hash: int,
@@ -204,7 +204,7 @@ async def sign_declare_v3_transaction(
         """
 
     @abstractmethod
-    async def sign_deploy_account_v1_transaction(
+    async def sign_deploy_account_v1(
         self,
         class_hash: int,
         contract_address_salt: int,
@@ -230,7 +230,7 @@ async def sign_deploy_account_v1_transaction(
         """
 
     @abstractmethod
-    async def sign_deploy_account_v3_transaction(
+    async def sign_deploy_account_v3(
         self,
         class_hash: int,
         contract_address_salt: int,