Merge pull request #22 from bloxbean/fix/slot-config-tx-evaluation

Fix/slot config tx evaluation
bloxbean · Sep 20, 2024 · c072528 · c072528
2 parents 83ca55c + c6e14d5
commit c072528
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 3 deletions.
diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,4 @@
 group = com.bloxbean.cardano
 artifactId = aiken-java-binding
-version = 0.0.9-rc1
+version = 0.0.9-rc2
 
diff --git a/src/main/java/com/bloxbean/cardano/aiken/AikenTransactionEvaluator.java b/src/main/java/com/bloxbean/cardano/aiken/AikenTransactionEvaluator.java
@@ -13,6 +13,8 @@
 import com.bloxbean.cardano.client.backend.api.BackendService;
 import com.bloxbean.cardano.client.backend.api.DefaultProtocolParamsSupplier;
 import com.bloxbean.cardano.client.backend.api.DefaultUtxoSupplier;
+import com.bloxbean.cardano.client.common.model.SlotConfig;
+import com.bloxbean.cardano.client.common.model.SlotConfigs;
 import com.bloxbean.cardano.client.plutus.spec.*;
 import com.bloxbean.cardano.client.transaction.spec.Transaction;
 import com.bloxbean.cardano.client.transaction.spec.TransactionInput;
@@ -35,15 +37,29 @@ public class AikenTransactionEvaluator implements TransactionEvaluator {
     private UtxoSupplier utxoSupplier;
     private ProtocolParamsSupplier protocolParamsSupplier;
     private ScriptSupplier scriptSupplier;
+    private final SlotConfig slotConfig;
 
     /**
-     * Constructor
+     * Constructor for mainnet.
+     * Use AikenTransactionEvaluator(@NonNull BackendService backendService, SlotConfig slotConfig)
+     * if you need to run TransactionEvaluation for any non-mainnet network instead
      *
      * @param backendService Backend service
      */
     public AikenTransactionEvaluator(@NonNull BackendService backendService) {
+        this(backendService, SlotConfigs.mainnet());
+    }
+
+    /**
+     * Constructor
+     *
+     * @param backendService Backend service
+     * @param slotConfig the slot config to use, useful for non-mainnet network tx evaluation
+     */
+    public AikenTransactionEvaluator(@NonNull BackendService backendService, SlotConfig slotConfig) {
         this.utxoSupplier = new DefaultUtxoSupplier(backendService.getUtxoService());
         this.protocolParamsSupplier = new DefaultProtocolParamsSupplier(backendService.getEpochService());
+        this.slotConfig = slotConfig;
     }
 
     /**
@@ -55,6 +71,7 @@ public AikenTransactionEvaluator(@NonNull BackendService backendService, ScriptS
         this.utxoSupplier = new DefaultUtxoSupplier(backendService.getUtxoService());
         this.protocolParamsSupplier = new DefaultProtocolParamsSupplier(backendService.getEpochService());
         this.scriptSupplier = scriptSupplier;
+        this.slotConfig = SlotConfigs.mainnet();
     }
 
     /**
@@ -66,6 +83,7 @@ public AikenTransactionEvaluator(@NonNull BackendService backendService, ScriptS
     public AikenTransactionEvaluator(@NonNull UtxoSupplier utxoSupplier, @NonNull ProtocolParamsSupplier protocolParamsSupplier) {
         this.utxoSupplier = utxoSupplier;
         this.protocolParamsSupplier = protocolParamsSupplier;
+        this.slotConfig = SlotConfigs.mainnet();
     }
 
     /**
@@ -76,9 +94,23 @@ public AikenTransactionEvaluator(@NonNull UtxoSupplier utxoSupplier, @NonNull Pr
      */
     public AikenTransactionEvaluator(@NonNull UtxoSupplier utxoSupplier, @NonNull ProtocolParamsSupplier protocolParamsSupplier,
                                      ScriptSupplier scriptSupplier) {
+        this(utxoSupplier, protocolParamsSupplier, scriptSupplier, SlotConfigs.mainnet());
+    }
+
+
+    /**
+     * Constructor
+     * @param utxoSupplier Utxo supplier
+     * @param protocolParamsSupplier Protocol params supplier
+     * @param scriptSupplier Script supplier to provide additional scripts (e.g; scripts in reference inputs) to evaluate
+     * * @param slotConfig the slot config to use, useful for non-mainnet network tx evaluation
+     */
+    public AikenTransactionEvaluator(@NonNull UtxoSupplier utxoSupplier, @NonNull ProtocolParamsSupplier protocolParamsSupplier,
+                                     ScriptSupplier scriptSupplier, SlotConfig slotConfig) {
         this.utxoSupplier = utxoSupplier;
         this.protocolParamsSupplier = protocolParamsSupplier;
         this.scriptSupplier = scriptSupplier;
+        this.slotConfig = slotConfig;
     }
 
     @Override
@@ -129,7 +161,7 @@ public Result<List<EvaluationResult>> evaluateTx(byte[] cbor, Set<Utxo> inputUtx
             CostMdls costMdls = new CostMdls();
             costMdls.add(costModelOptional.get());
 
-            TxEvaluator txEvaluator = new TxEvaluator();
+            TxEvaluator txEvaluator = new TxEvaluator(getSlotConfig());
             List<Redeemer> redeemers = txEvaluator.evaluateTx(transaction, utxos, additionalScripts, costMdls);
             if (redeemers == null)
                 return Result.success("Error evaluating transaction");
@@ -144,4 +176,12 @@ public Result<List<EvaluationResult>> evaluateTx(byte[] cbor, Set<Utxo> inputUtx
             throw new ApiException("Error evaluating transaction", e);
         }
     }
+
+    private com.bloxbean.cardano.aiken.tx.evaluator.SlotConfig getSlotConfig() {
+        com.bloxbean.cardano.aiken.tx.evaluator.SlotConfig.SlotConfigByReference slotConfig = new com.bloxbean.cardano.aiken.tx.evaluator.SlotConfig.SlotConfigByReference();
+        slotConfig.zero_time = this.slotConfig.getZeroTime();
+        slotConfig.zero_slot = this.slotConfig.getZeroSlot();
+        slotConfig.slot_length = this.slotConfig.getSlotLength();
+        return slotConfig;
+    }
 }
diff --git a/src/main/java/com/bloxbean/cardano/aiken/tx/evaluator/TxEvaluator.java b/src/main/java/com/bloxbean/cardano/aiken/tx/evaluator/TxEvaluator.java
@@ -66,6 +66,29 @@ public TxEvaluator(InitialBudgetConfig initialBudgetConfig) {
         this.initialBudgetConfig.cpu = initialBudgetConfig.cpu;
     }
 
+        /**
+     * Construct instance of TxEvaluator with an initial transaction budget config.
+     * Those values are typically present on protocol-parameters.json.
+     *
+     * "maxTxExecutionUnits": {
+     *   "memory": 14000000,
+     *   "steps": 10000000000
+     *  }
+     *
+     *  Typical scenario to override those values is where one uses L2 solution, e.g. Hydra
+     *  with custom config or custom dev network (e.g. using yaci-devkit).
+     *
+     * @param slotConfig - slot config values as specified during shelley genesis era
+     */
+    public TxEvaluator(SlotConfig slotConfig) {
+        this.slotConfig = new SlotConfig.SlotConfigByReference();
+        this.slotConfig.zero_slot = slotConfig.zero_slot;
+        this.slotConfig.zero_time = slotConfig.zero_time;
+        this.slotConfig.slot_length = slotConfig.slot_length;
+
+        this.initialBudgetConfig = getDefaultInitialBudgetConfig();
+    }
+
     /**
      * Construct instance of TxEvaluator with an initial transaction budget config.
      * Those values are typically present on