Support mint redeemer

Author: cffls

pycardano/txbuilder.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from copy import deepcopy
-from typing import List, Optional, Set, Union
+from typing import Dict, List, Optional, Set, Union
 
 from pycardano.address import Address
 from pycardano.backend.base import ChainContext
@@ -17,12 +17,19 @@
     TransactionBuilderException,
     UTxOSelectionException,
 )
-from pycardano.hash import ScriptDataHash, ScriptHash, VerificationKeyHash
+from pycardano.hash import DatumHash, ScriptDataHash, ScriptHash, VerificationKeyHash
 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
-from pycardano.plutus import Datum, ExecutionUnits, Redeemer, datum_hash
+from pycardano.plutus import (
+    Datum,
+    ExecutionUnits,
+    Redeemer,
+    RedeemerTag,
+    datum_hash,
+    plutus_script_hash,
+)
 from pycardano.transaction import (
     Asset,
     AssetName,
@@ -74,10 +81,11 @@ def __init__(
         self._native_scripts = None
         self._mint = None
         self._required_signers = None
-        self._scripts = []
-        self._datums = []
+        self._scripts = {}
+        self._datums = {}
         self._redeemers = []
         self._inputs_to_redeemers = {}
+        self._inputs_to_scripts = {}
         self._collaterals = []
 
         if utxo_selectors:
@@ -121,10 +129,11 @@ def add_script_input(
                 f"Datum hash in transaction output is {utxo.output.datum_hash}, "
                 f"but actual datum hash from input datum is {datum.hash()}."
             )
-        self.scripts.append(script)
-        self.datums.append(datum)
+        self.scripts[plutus_script_hash(script)] = script
+        self.datums[datum.hash()] = datum
         self.redeemers.append(redeemer)
         self._inputs_to_redeemers[utxo] = redeemer
+        self._inputs_to_scripts[utxo] = script
         self.inputs.append(utxo)
         return self
 
@@ -163,7 +172,7 @@ def add_output(
             tx_out.datum_hash = datum_hash(datum)
         self.outputs.append(tx_out)
         if add_datum_to_witness:
-            self.datums.append(datum)
+            self.datums[datum.hash()] = datum
         return self
 
     @property
@@ -243,11 +252,11 @@ def required_signers(self, signers: List[VerificationKeyHash]):
         self._required_signers = signers
 
     @property
-    def scripts(self) -> List[bytes]:
+    def scripts(self) -> Dict[ScriptHash, bytes]:
         return self._scripts
 
     @property
-    def datums(self) -> List[Datum]:
+    def datums(self) -> Dict[DatumHash, Datum]:
         return self._datums
 
     @property
@@ -265,7 +274,7 @@ def collaterals(self, collaterals: List[UTxO]):
     @property
     def script_data_hash(self) -> Optional[ScriptDataHash]:
         if self.datums or self.redeemers:
-            return script_data_hash(self.redeemers, self.datums)
+            return script_data_hash(self.redeemers, list(self.datums.values()))
         else:
             return None
 
@@ -291,10 +300,6 @@ def _calc_change(
             )
 
         change = provided - requested
-        if change.coin < 0:
-            # We assign max fee for now to ensure enough balance regardless of splits condition
-            # We can implement a more precise fee logic and requirements later
-            raise InsufficientUTxOBalanceException("Not enough ADA to cover fees")
 
         # Remove any asset that has 0 quantity
         if change.multi_asset:
@@ -495,9 +500,30 @@ def _dfs(script: NativeScript):
         return results
 
     def _set_redeemer_index(self):
+        # Set redeemers' index according to section 4.1 in
+        # https://hydra.iohk.io/build/13099856/download/1/alonzo-changes.pdf
+
+        if self.mint:
+            sorted_mint_policies = sorted(
+                self.mint.keys(), key=lambda x: x.to_cbor("bytes")
+            )
+        else:
+            sorted_mint_policies = []
+
         for i, utxo in enumerate(self.inputs):
-            if utxo in self._inputs_to_redeemers:
+            if (
+                utxo in self._inputs_to_redeemers
+                and self._inputs_to_redeemers[utxo].tag == RedeemerTag.SPEND
+            ):
                 self._inputs_to_redeemers[utxo].index = i
+            elif (
+                utxo in self._inputs_to_redeemers
+                and self._inputs_to_redeemers[utxo].tag == RedeemerTag.MINT
+            ):
+                redeemer = self._inputs_to_redeemers[utxo]
+                redeemer.index = sorted_mint_policies.index(
+                    plutus_script_hash(self._inputs_to_scripts[utxo])
+                )
         self.redeemers.sort(key=lambda r: r.index)
 
     def _build_tx_body(self) -> TransactionBody:
@@ -553,9 +579,9 @@ def build_witness_set(self) -> TransactionWitnessSet:
         """
         return TransactionWitnessSet(
             native_scripts=self.native_scripts,
-            plutus_script=self.scripts if self.scripts else None,
+            plutus_script=list(self.scripts.values()) if self.scripts else None,
             redeemer=self.redeemers if self.redeemers else None,
-            plutus_data=self.datums if self.datums else None,
+            plutus_data=list(self.datums.values()) if self.datums else None,
         )
 
     def _ensure_no_input_exclusion_conflict(self):
@@ -611,7 +637,11 @@ def build(self, change_address: Optional[Address] = None) -> TransactionBody:
             additional_amount = Value()
             for address in self.input_addresses:
                 for utxo in self.context.utxos(str(address)):
-                    if utxo not in selected_utxos and utxo not in self.excluded_inputs:
+                    if (
+                        utxo not in selected_utxos
+                        and utxo not in self.excluded_inputs
+                        and not utxo.output.datum_hash  # UTxO with datum should be added by using `add_script_input`
+                    ):
                         additional_utxo_pool.append(utxo)
                         additional_amount += utxo.output.amount
 

pycardano/utils.py

@@ -10,7 +10,7 @@
 
 from pycardano.backend.base import ChainContext
 from pycardano.hash import SCRIPT_DATA_HASH_SIZE, SCRIPT_HASH_SIZE, ScriptDataHash
-from pycardano.plutus import COST_MODELS, CostModels, PlutusData, Redeemer
+from pycardano.plutus import COST_MODELS, CostModels, Datum, Redeemer
 from pycardano.serialization import default_encoder
 from pycardano.transaction import MultiAsset, Value
 
@@ -116,14 +116,14 @@ def min_lovelace(
 
 def script_data_hash(
     redeemers: List[Redeemer],
-    datums: List[PlutusData],
+    datums: List[Datum],
     cost_models: Optional[CostModels] = None,
 ) -> ScriptDataHash:
     """Calculate plutus script data hash
 
     Args:
         redeemers (List[Redeemer]): Redeemers to include.
-        datums (List[PlutusData]): Datums to include.
+        datums (List[Datum]): Datums to include.
         cost_models (Optional[CostModels]): Cost models.
 
     Returns:

test/pycardano/test_txbuilder.py

@@ -22,8 +22,20 @@
     ScriptAll,
     ScriptPubkey,
 )
-from pycardano.plutus import ExecutionUnits, PlutusData, Redeemer, RedeemerTag
-from pycardano.transaction import MultiAsset, TransactionInput, TransactionOutput, UTxO
+from pycardano.plutus import (
+    ExecutionUnits,
+    PlutusData,
+    Redeemer,
+    RedeemerTag,
+    plutus_script_hash,
+)
+from pycardano.transaction import (
+    MultiAsset,
+    TransactionInput,
+    TransactionOutput,
+    UTxO,
+    Value,
+)
 from pycardano.txbuilder import TransactionBuilder
 from pycardano.witness import VerificationKeyWitness
 
@@ -327,39 +339,54 @@ def test_not_enough_input_amount(chain_context):
 
 def test_add_script_input(chain_context):
     tx_builder = TransactionBuilder(chain_context)
-    tx_in = TransactionInput.from_primitive(
+    tx_in1 = TransactionInput.from_primitive(
         ["18cbe6cadecd3f89b60e08e68e5e6c7d72d730aaa1ad21431590f7e6643438ef", 0]
     )
-    plutus_script = b"dummy test script"
-    script_hash = ScriptHash(
-        blake2b(
-            bytes(1) + cbor2.dumps(plutus_script), SCRIPT_HASH_SIZE, encoder=RawEncoder
-        )
+    tx_in2 = TransactionInput.from_primitive(
+        ["18cbe6cadecd3f89b60e08e68e5e6c7d72d730aaa1ad21431590f7e6643438ef", 1]
     )
+    plutus_script = b"dummy test script"
+    script_hash = plutus_script_hash(plutus_script)
     script_address = Address(script_hash)
     datum = PlutusData()
-    tx_out = TransactionOutput(script_address, 10000000, datum_hash=datum.hash())
-    utxo = UTxO(tx_in, tx_out)
-    redeemer = Redeemer(
+    utxo1 = UTxO(
+        tx_in1, TransactionOutput(script_address, 10000000, datum_hash=datum.hash())
+    )
+    mint = MultiAsset.from_primitive({script_hash.payload: {b"TestToken": 1}})
+    utxo2 = UTxO(
+        tx_in2,
+        TransactionOutput(
+            script_address, Value(10000000, mint), datum_hash=datum.hash()
+        ),
+    )
+    redeemer1 = Redeemer(
         RedeemerTag.SPEND, PlutusData(), ExecutionUnits(1000000, 1000000)
     )
-    tx_builder.add_script_input(utxo, plutus_script, datum, redeemer)
+    redeemer2 = Redeemer(
+        RedeemerTag.MINT, PlutusData(), ExecutionUnits(1000000, 1000000)
+    )
+    tx_builder.mint = mint
+    tx_builder.add_script_input(utxo1, plutus_script, datum, redeemer1)
+    tx_builder.add_script_input(utxo2, plutus_script, datum, redeemer2)
     receiver = Address.from_primitive(
         "addr_test1vrm9x2zsux7va6w892g38tvchnzahvcd9tykqf3ygnmwtaqyfg52x"
     )
     tx_builder.add_output(TransactionOutput(receiver, 5000000))
     tx_body = tx_builder.build(change_address=receiver)
     witness = tx_builder.build_witness_set()
     assert [datum] == witness.plutus_data
-    assert [redeemer] == witness.redeemer
+    assert [redeemer1, redeemer2] == witness.redeemer
     assert [plutus_script] == witness.plutus_script
     assert (
-        "a4008182582018cbe6cadecd3f89b60e08e68e5e6c7d72d730aaa1ad2143159"
-        "0f7e6643438ef00018282581d60f6532850e1bccee9c72a9113ad98bcc5dbb3"
-        "0d2ac960262444f6e5f41a004c4b4082581d60f6532850e1bccee9c72a9113a"
-        "d98bcc5dbb30d2ac960262444f6e5f41a0048e737021a000364090b5820032d"
-        "812ee0731af78fe4ec67e4d30d16313c09e6fb675af28f825797e8b5621d"
-        == tx_body.to_cbor()
+        "a5008282582018cbe6cadecd3f89b60e08e68e5e6c7d72d730aaa1ad2143159"
+        "0f7e6643438ef0082582018cbe6cadecd3f89b60e08e68e5e6c7d72d730aaa1"
+        "ad21431590f7e6643438ef01018282581d60f6532850e1bccee9c72a9113ad9"
+        "8bcc5dbb30d2ac960262444f6e5f41a004c4b4082581d60f6532850e1bccee9"
+        "c72a9113ad98bcc5dbb30d2ac960262444f6e5f4821a00e083cfa1581c876f1"
+        "9078b059c928258d848c8cd871864d281eb6776ed7f80b68536a14954657374"
+        "546f6b656e02021a00045df109a1581c876f19078b059c928258d848c8cd871"
+        "864d281eb6776ed7f80b68536a14954657374546f6b656e010b5820c0978261"
+        "d9818d92926eb031d38d141f513a05478d697555f32edf6443ebeb08" == tx_body.to_cbor()
     )