Add 'build_and_sign' to tx builder

Author: cffls

integration-test/test/test_all.py

@@ -152,36 +152,9 @@ def load_or_create_key_pair(base_dir, base_name):
         nft_output = TransactionOutput(address, Value(min_val, my_nft))
         builder.add_output(nft_output)
 
-        # Build a finalized transaction body with the change returning to our own address
-        tx_body = builder.build(change_address=address)
-
-        """Sign transaction and add witnesses"""
-        # Sign the transaction body hash using the payment signing key
-        payment_signature = self.payment_skey.sign(tx_body.hash())
-
-        # Sign the transaction body hash using the extended payment signing key
-        extended_payment_signature = self.extended_payment_skey.sign(tx_body.hash())
-
-        # Sign the transaction body hash using the policy signing key because we are minting new tokens
-        policy_signature = policy_skey.sign(tx_body.hash())
-
-        # Add verification keys and their signatures to the witness set
-        vk_witnesses = [
-            VerificationKeyWitness(self.payment_vkey, payment_signature),
-            VerificationKeyWitness(policy_vkey, policy_signature),
-            VerificationKeyWitness(
-                self.extended_payment_vkey, extended_payment_signature
-            ),
-        ]
-
-        # Create final signed transaction
-        signed_tx = Transaction(
-            tx_body,
-            # Beside vk witnesses, We also need to add the policy script to witness set when we are minting new tokens.
-            TransactionWitnessSet(
-                vkey_witnesses=vk_witnesses, native_scripts=native_scripts
-            ),
-            auxiliary_data=auxiliary_data,
+        # Build and sign transaction
+        signed_tx = builder.build_and_sign(
+            [self.payment_skey, self.extended_payment_skey, policy_skey], address
         )
 
         print("############### Transaction created ###############")
@@ -217,23 +190,8 @@ def load_or_create_key_pair(base_dir, base_name):
 
         builder.add_output(nft_to_send)
 
-        tx_body = builder.build(change_address=address)
-
-        """Sign transaction and add witnesses"""
-        # Sign the transaction body hash using the payment signing key
-        payment_signature = self.payment_skey.sign(tx_body.hash())
-
-        # Add verification keys and their signatures to the witness set
-        vk_witnesses = [
-            VerificationKeyWitness(self.payment_vkey, payment_signature),
-        ]
-
         # Create final signed transaction
-        signed_tx = Transaction(
-            tx_body,
-            # Beside vk witnesses, We also need to add the policy script to witness set when we are minting new tokens.
-            TransactionWitnessSet(vkey_witnesses=vk_witnesses),
-        )
+        signed_tx = builder.build_and_sign([self.payment_skey], address)
 
         print("############### Transaction created ###############")
         print(signed_tx)
@@ -277,19 +235,7 @@ def test_plutus(self):
             TransactionOutput(script_address, 50000000, datum_hash=datum_hash(datum))
         )
 
-        tx_body = builder.build(change_address=giver_address)
-        witness_set = builder.build_witness_set()
-
-        payment_signature = self.payment_skey.sign(tx_body.hash())
-
-        witness_set.vkey_witnesses = [
-            VerificationKeyWitness(self.payment_vkey, payment_signature),
-        ]
-
-        signed_tx = Transaction(
-            tx_body,
-            witness_set,
-        )
+        signed_tx = builder.build_and_sign([self.payment_skey], giver_address)
 
         print("############### Transaction created ###############")
         print(signed_tx)
@@ -307,19 +253,7 @@ def test_plutus(self):
         builder.add_input_address(giver_address)
         builder.add_output(TransactionOutput(taker_address, 5000000))
 
-        tx_body = builder.build(change_address=giver_address)
-        witness_set = builder.build_witness_set()
-
-        payment_signature = self.payment_skey.sign(tx_body.hash())
-
-        witness_set.vkey_witnesses = [
-            VerificationKeyWitness(self.payment_vkey, payment_signature),
-        ]
-
-        signed_tx = Transaction(
-            tx_body,
-            witness_set,
-        )
+        signed_tx = builder.build_and_sign([self.payment_skey], giver_address)
 
         print("############### Transaction created ###############")
         print(signed_tx)
@@ -352,19 +286,7 @@ def test_plutus(self):
 
         builder.collaterals.append(non_nft_utxo)
 
-        tx_body = builder.build(change_address=taker_address)
-        witness_set = builder.build_witness_set()
-
-        collateral_signature = self.extended_payment_skey.sign(tx_body.hash())
-
-        witness_set.vkey_witnesses = [
-            VerificationKeyWitness(self.extended_payment_vkey, collateral_signature),
-        ]
-
-        signed_tx = Transaction(
-            tx_body,
-            witness_set,
-        )
+        signed_tx = builder.build_and_sign([self.extended_payment_skey], taker_address)
 
         print("############### Transaction created ###############")
         print(signed_tx)

pycardano/key.py

@@ -143,6 +143,14 @@ def sign(self, data: bytes) -> bytes:
         signed_message = NACLSigningKey(self.payload).sign(data)
         return signed_message.signature
 
+    def to_verification_key(self) -> VerificationKey:
+        verification_key = NACLSigningKey(self.payload).verify_key
+        return VerificationKey(
+            bytes(verification_key),
+            self.key_type.replace("Signing", "Verification"),
+            self.description.replace("Signing", "Verification"),
+        )
+
     @classmethod
     def generate(cls) -> SigningKey:
         signing_key = PrivateKey.generate()
@@ -162,19 +170,21 @@ def hash(self) -> VerificationKeyHash:
 
     @classmethod
     def from_signing_key(cls, key: SigningKey) -> VerificationKey:
-        verification_key = NACLSigningKey(bytes(key)).verify_key
-        return cls(
-            bytes(verification_key),
-            key.key_type.replace("Signing", "Verification"),
-            key.description.replace("Signing", "Verification"),
-        )
+        return key.to_verification_key()
 
 
 class ExtendedSigningKey(Key):
     def sign(self, data: bytes) -> bytes:
         private_key = BIP32ED25519PrivateKey(self.payload[:64], self.payload[96:])
         return private_key.sign(data)
 
+    def to_verification_key(self) -> ExtendedVerificationKey:
+        return ExtendedVerificationKey(
+            self.payload[64:],
+            self.key_type.replace("Signing", "Verification"),
+            self.description.replace("Signing", "Verification"),
+        )
+
 
 class ExtendedVerificationKey(Key):
     def hash(self) -> VerificationKeyHash:
@@ -187,11 +197,7 @@ def hash(self) -> VerificationKeyHash:
 
     @classmethod
     def from_signing_key(cls, key: ExtendedSigningKey) -> ExtendedVerificationKey:
-        return cls(
-            key.payload[64:],
-            key.key_type.replace("Signing", "Verification"),
-            key.description.replace("Signing", "Verification"),
-        )
+        return key.to_verification_key()
 
     def to_non_extended(self) -> VerificationKey:
         """Get the 32-byte verification with chain code trimmed off

pycardano/txbuilder.py

@@ -18,7 +18,7 @@
     UTxOSelectionException,
 )
 from pycardano.hash import ScriptDataHash, ScriptHash, VerificationKeyHash
-from pycardano.key import VerificationKey
+from pycardano.key import ExtendedSigningKey, SigningKey, VerificationKey
 from pycardano.logging import logger
 from pycardano.metadata import AuxiliaryData
 from pycardano.nativescript import NativeScript, ScriptAll, ScriptAny, ScriptPubkey
@@ -646,3 +646,33 @@ def build(self, change_address: Optional[Address] = None) -> TransactionBody:
         tx_body = self._build_tx_body()
 
         return tx_body
+
+    def build_and_sign(
+        self,
+        signing_keys: List[Union[SigningKey, ExtendedSigningKey]],
+        change_address: Optional[Address] = None,
+    ) -> Transaction:
+        """Build a transaction body from all constraints set through the builder and sign the transaction with
+            provided signing keys.
+
+        Args:
+            signing_keys (List[Union[SigningKey, ExtendedSigningKey]]): A list of signing keys that will be used to
+                sign the transaction.
+            change_address (Optional[Address]): Address to which changes will be returned. If not provided, the
+                transaction body will likely be unbalanced (sum of inputs is greater than the sum of outputs).
+
+        Returns:
+            Transaction: A signed transaction.
+        """
+
+        tx_body = self.build(change_address=change_address)
+        witness_set = self.build_witness_set()
+        witness_set.vkey_witnesses = []
+
+        for signing_key in signing_keys:
+            signature = signing_key.sign(tx_body.hash())
+            witness_set.vkey_witnesses.append(
+                VerificationKeyWitness(signing_key.to_verification_key(), signature)
+            )
+
+        return Transaction(tx_body, witness_set, auxiliary_data=self.auxiliary_data)

test/pycardano/test_txbuilder.py

@@ -1,4 +1,5 @@
 from dataclasses import replace
+from test.pycardano.test_key import SK
 from test.pycardano.util import chain_context
 
 import cbor2
@@ -23,6 +24,7 @@
 from pycardano.plutus import ExecutionUnits, PlutusData, Redeemer, RedeemerTag
 from pycardano.transaction import MultiAsset, TransactionInput, TransactionOutput, UTxO
 from pycardano.txbuilder import TransactionBuilder
+from pycardano.witness import VerificationKeyWitness
 
 
 def test_tx_builder(chain_context):
@@ -371,3 +373,35 @@ def test_excluded_input(chain_context):
     }
 
     assert expected == tx_body.to_primitive()
+
+
+def test_build_and_sign(chain_context):
+    sender = "addr_test1vrm9x2zsux7va6w892g38tvchnzahvcd9tykqf3ygnmwtaqyfg52x"
+    sender_address = Address.from_primitive(sender)
+
+    tx_builder1 = TransactionBuilder(
+        chain_context, [RandomImproveMultiAsset([0, 0, 0, 0, 0])]
+    )
+    tx_builder1.add_input_address(sender).add_output(
+        TransactionOutput.from_primitive([sender, 500000])
+    )
+
+    tx_body = tx_builder1.build(change_address=sender_address)
+
+    tx_builder2 = TransactionBuilder(
+        chain_context, [RandomImproveMultiAsset([0, 0, 0, 0, 0])]
+    )
+    tx_builder2.add_input_address(sender).add_output(
+        TransactionOutput.from_primitive([sender, 500000])
+    )
+    tx = tx_builder2.build_and_sign([SK], change_address=sender_address)
+
+    assert tx.transaction_witness_set.vkey_witnesses == [
+        VerificationKeyWitness(SK.to_verification_key(), SK.sign(tx_body.hash()))
+    ]
+    assert (
+        "a300818258203131313131313131313131313131313131313131313131313131313131313131"
+        "00018282581d60f6532850e1bccee9c72a9113ad98bcc5dbb30d2ac960262444f6e5f41a0007"
+        "a12082581d60f6532850e1bccee9c72a9113ad98bcc5dbb30d2ac960262444f6e5f41a004223"
+        "a3021a0002867d" == tx_body.to_cbor()
+    )