@harmoniclabs/buildooor 0.1.3 → 0.1.5

package/dist/TxBuilder/TxBuilder.d.ts

@@ -17,7 +17,7 @@ export declare class TxBuilder {
     constructor(protocolParamters?: Readonly<TxBuilderProtocolParams>, genesisInfos?: GenesisInfos);
     keepRelevant(requestedOutputSet: Value | ValueUnits, initialUTxOSet: ITxBuildInput[], minimumLovelaceRequired?: CanBeUInteger): ITxBuildInput[];
     private calcLinearFee;
-    calcMinFee(tx: Tx): bigint;
+    calcMinFee(tx: Tx, minimum?: CanBeUInteger | undefined): bigint;
     getMinimumOutputLovelaces(tx_out: TxOut | CanBeCborString): bigint;
     addMinLovelacesIfMissing(txOut: TxOut): TxOut;
     minimizeLovelaces(out: ITxOut): TxOut;
@@ -56,6 +56,7 @@ export declare class TxBuilder {
      */
     overrideTxRedeemers(tx: Tx, newRedeemers: TxRedeemer[], opts?: CostModelsToLanguageViewCborOpts): Tx;
     buildSync(buildArgs: ITxBuildArgs, { onScriptInvalid, onScriptResult }?: ITxBuildSyncOptions): Tx;
+    validatePhaseTwo(tx: Tx): boolean;
     assertMinOutLovelaces(txOuts: TxOut[]): void;
     /**
      * extracts the important data from the input

package/dist/TxBuilder/TxBuilder.js

@@ -116,6 +116,7 @@ var TxBuilderProtocolParams_1 = require("./TxBuilderProtocolParams.js");
 var utils_1 = require("./utils.js");
 var Rational_1 = require("../utils/Rational.js");
 var stringify_1 = require("../utils/stringify.js");
+var getScript_1 = require("./utils/getScript.js");
 // const scriptCache: { [x: string]: UPLCTerm } = {};
 function getScriptLikeUplc(scriptLike) {
     return uplc_1.UPLCDecoder.parse(scriptLike.bytes, "flat").body;
@@ -173,7 +174,7 @@ var TxBuilder = /** @class */ (function () {
             ) +
             (0, ints_1.forceBigUInt)(this.protocolParamters.txFeeFixed));
     };
-    TxBuilder.prototype.calcMinFee = function (tx) {
+    TxBuilder.prototype.calcMinFee = function (tx, minimum) {
         var _a;
         var totRefScriptBytes = ((_a = tx.body.refInputs) !== null && _a !== void 0 ? _a : [])
             .reduce(function (sum, refIn) {
@@ -198,7 +199,10 @@ var TxBuilder = /** @class */ (function () {
             BigInt(104) * nVkeyWits * minFeeMultiplier +
             // we add some more bytes for the array tag
             BigInt(nVkeyWits < 24 ? 1 : (nVkeyWits < 256 ? 2 : 4)) * minFeeMultiplier;
-        return minFee;
+        if (!(0, ints_1.canBeUInteger)(minimum))
+            return minFee;
+        var min = (0, ints_1.forceBigUInt)(minimum);
+        return minFee < min ? min : minFee;
     };
     TxBuilder.prototype.getMinimumOutputLovelaces = function (tx_out) {
         var size = BigInt(0);
@@ -410,7 +414,7 @@ var TxBuilder = /** @class */ (function () {
             for (var i = 0; i < nRdmrs; i++) {
                 _loop_2(i);
             }
-            minFee = this_1.calcMinFee(tx);
+            minFee = this_1.calcMinFee(tx, buildArgs.fee);
             fee = minFee +
                 ((totExBudget.mem * memRational.num) / memRational.den) +
                 ((totExBudget.cpu * cpuRational.num) / cpuRational.den) +
@@ -448,6 +452,135 @@ var TxBuilder = /** @class */ (function () {
         this.assertMinOutLovelaces(tx.body.outputs);
         return tx;
     };
+    TxBuilder.prototype.validatePhaseTwo = function (tx) {
+        var txBody = tx.body;
+        var rdmrs = tx.witnesses.redeemers;
+        if (!Array.isArray(rdmrs) || rdmrs.length === 0)
+            return true;
+        var nRdmrs = rdmrs.length;
+        var cek = this.cek;
+        if (!(cek instanceof plutus_machine_1.Machine))
+            throw new Error("protocol params are missing the script evaluation costs");
+        var executionUnitPrices = this.protocolParamters.executionUnitPrices;
+        executionUnitPrices = Array.isArray(executionUnitPrices) ? executionUnitPrices : [
+            executionUnitPrices.priceMemory,
+            executionUnitPrices.priceSteps,
+        ];
+        var _a = __read(executionUnitPrices, 2), memRational = _a[0], cpuRational = _a[1];
+        memRational = typeof memRational === "number" ? cbor_1.CborPositiveRational.fromNumber(memRational) : memRational;
+        cpuRational = typeof cpuRational === "number" ? cbor_1.CborPositiveRational.fromNumber(cpuRational) : cpuRational;
+        var _b = (0, toOnChain_1.getTxInfos)(tx, this.genesisInfos), txInfosV1 = _b.v1, txInfosV2 = _b.v2, txInfosV3 = _b.v3;
+        var totExBudget = new plutus_machine_1.ExBudget({ mem: 0, cpu: 0 });
+        var _loop_3 = function (i) {
+            var rdmr = rdmrs[i];
+            var tag = rdmr.tag, rdmrData = rdmr.data, rdmr_idx = rdmr.index;
+            // "+ 1" because we keep track of lovelaces even if in mint values these are 0
+            var index = rdmr_idx + (tag === cardano_ledger_ts_1.TxRedeemerTag.Mint ? 1 : 0);
+            var onlyRedeemerArg = function (script) {
+                if (!(script instanceof cardano_ledger_ts_1.Script))
+                    throw new Error("missing script for " + (0, cardano_ledger_ts_1.txRedeemerTagToString)(tag) + " redeemer " + (index - 1));
+                var expectedVersion = (0, utils_1.scriptTypeToDataVersion)(script.type);
+                if (typeof expectedVersion !== "string")
+                    throw new Error("unexpected redeemer for native script");
+                var ctxData = getCtx(script.type, (0, getSpendingPurposeData_1.getSpendingPurposeData)(rdmr, tx.body, expectedVersion), (0, getSpendingPurposeData_1.getScriptInfoData)(rdmr, tx.body, expectedVersion), rdmrData, txInfosV1, txInfosV2, txInfosV3);
+                var isV2OrLess = (script.type === cardano_ledger_ts_1.ScriptType.PlutusV1 ||
+                    script.type === cardano_ledger_ts_1.ScriptType.PlutusV2 ||
+                    script.type === cardano_ledger_ts_1.ScriptType.NativeScript);
+                var _a = cek.eval(isV2OrLess ?
+                    new uplc_1.Application(new uplc_1.Application((0, uplc_1.parseUPLC)(script.bytes).body, uplc_1.UPLCConst.data(rdmrData)), uplc_1.UPLCConst.data(ctxData)) :
+                    new uplc_1.Application((0, uplc_1.parseUPLC)(script.bytes).body, uplc_1.UPLCConst.data(ctxData))), result = _a.result, budgetSpent = _a.budgetSpent, logs = _a.logs;
+                var successExec = isV2OrLess ?
+                    !(result instanceof uplc_1.ErrorUPLC) :
+                    ( // v3 requires to return unit
+                    result instanceof uplc_1.UPLCConst
+                        && Array.isArray(result.type)
+                        && result.type.length === 1
+                        && result.type[0] === uplc_1.ConstTyTag.unit
+                        && result.value === undefined);
+                if (!successExec)
+                    return false;
+                if (budgetSpent.cpu > rdmr.execUnits.cpu
+                    || budgetSpent.mem > rdmr.execUnits.mem)
+                    return false;
+                totExBudget.add(rdmr.execUnits);
+                return true;
+            };
+            if (tag === cardano_ledger_ts_1.TxRedeemerTag.Spend) {
+                var entry = (0, getScript_1.getSpendingScript)(tx, index);
+                if (!entry)
+                    return { value: false };
+                var script = entry.script, datum = entry.datum;
+                // TODO: check if this is correct
+                // I'm assuming native scripts are phase 1
+                if (script.type === cardano_ledger_ts_1.ScriptType.NativeScript)
+                    return { value: true };
+                var isV2OrLess = script.type === cardano_ledger_ts_1.ScriptType.PlutusV1 || script.type === cardano_ledger_ts_1.ScriptType.PlutusV2;
+                if (datum === undefined && isV2OrLess)
+                    throw new Error("missing datum for spend redeemer " + index);
+                var expectedVersion = (0, utils_1.scriptTypeToDataVersion)(script.type);
+                if (typeof expectedVersion !== "string")
+                    throw new Error("unexpected redeemer for native script");
+                var ctxData = getCtx(script.type, (0, getSpendingPurposeData_1.getSpendingPurposeData)(rdmr, tx.body, expectedVersion), (0, getSpendingPurposeData_1.getScriptInfoData)(rdmr, tx.body, expectedVersion, datum), rdmrData, txInfosV1, txInfosV2, txInfosV3);
+                var _c = cek.eval(isV2OrLess ?
+                    new uplc_1.Application(new uplc_1.Application(new uplc_1.Application((0, uplc_1.parseUPLC)(script.bytes).body, uplc_1.UPLCConst.data(datum)), uplc_1.UPLCConst.data(rdmrData)), uplc_1.UPLCConst.data(ctxData)) :
+                    new uplc_1.Application((0, uplc_1.parseUPLC)(script.bytes).body, uplc_1.UPLCConst.data(ctxData))), result = _c.result, budgetSpent = _c.budgetSpent, logs = _c.logs;
+                var successExec = isV2OrLess ?
+                    !(result instanceof uplc_1.ErrorUPLC) :
+                    ( // v3 requires to return unit
+                    result instanceof uplc_1.UPLCConst
+                        && Array.isArray(result.type)
+                        && result.type.length === 1
+                        && result.type[0] === uplc_1.ConstTyTag.unit
+                        && result.value === undefined);
+                if (!successExec)
+                    return { value: false };
+                if (budgetSpent.cpu > rdmr.execUnits.cpu
+                    || budgetSpent.mem > rdmr.execUnits.mem)
+                    return { value: false };
+                totExBudget.add(rdmr.execUnits);
+                return "continue";
+            }
+            else if (tag === cardano_ledger_ts_1.TxRedeemerTag.Mint) {
+                if (onlyRedeemerArg((0, getScript_1.getMintingScript)(tx, index)))
+                    return "continue";
+                else
+                    return { value: false };
+            }
+            else if (tag === cardano_ledger_ts_1.TxRedeemerTag.Cert) {
+                if (onlyRedeemerArg((0, getScript_1.getCeritficateScript)(tx, index)))
+                    return "continue";
+                else
+                    return { value: false };
+            }
+            else if (tag === cardano_ledger_ts_1.TxRedeemerTag.Withdraw) {
+                if (onlyRedeemerArg((0, getScript_1.getWithdrawalScript)(tx, index)))
+                    return "continue";
+                else
+                    return { value: false };
+            }
+            else if (tag === cardano_ledger_ts_1.TxRedeemerTag.Voting) {
+                if (onlyRedeemerArg((0, getScript_1.getVotingScript)(tx, index)))
+                    return "continue";
+                else
+                    return { value: false };
+            }
+            else if (tag === cardano_ledger_ts_1.TxRedeemerTag.Proposing) {
+                if (onlyRedeemerArg((0, getScript_1.getProposingScript)(tx, index)))
+                    return "continue";
+                else
+                    return { value: false };
+            }
+            else
+                throw new Error("unrecoignized redeemer tag " + tag);
+            return { value: false };
+        };
+        for (var i = 0; i < nRdmrs; i++) {
+            var state_2 = _loop_3(i);
+            if (typeof state_2 === "object")
+                return state_2.value;
+        } // for loop over redeemers
+        return true;
+    };
     TxBuilder.prototype.assertMinOutLovelaces = function (txOuts) {
         for (var i = 0; i < txOuts.length; i++) {
             var out = txOuts[i];
@@ -945,9 +1078,7 @@ var TxBuilder = /** @class */ (function () {
             auxiliaryData: auxData,
             isScriptValid: isScriptValid
         });
-        var minFee = this.calcMinFee(dummyTx);
-        if (typeof args.fee === "bigint" && args.fee > minFee)
-            minFee = args.fee;
+        var minFee = this.calcMinFee(dummyTx, args.fee);
         var txOuts = new Array(outs.length + 1);
         outs.forEach(function (txO, i) { return txOuts[i] = _this.addMinLovelacesIfMissing(txO); });
         var changeOutput = new cardano_ledger_ts_1.TxOut({

package/dist/TxBuilder/utils/getScript.d.ts

@@ -0,0 +1,11 @@
+import { Script, Tx, ScriptType } from "@harmoniclabs/cardano-ledger-ts";
+import { Data } from "@harmoniclabs/plutus-data";
+export declare function getSpendingScript(tx: Tx, index: number): {
+    script: Script;
+    datum: Data | undefined;
+} | undefined;
+export declare function getMintingScript(tx: Tx, index: number): Script<ScriptType> | undefined;
+export declare function getCeritficateScript(tx: Tx, index: number): Script<ScriptType> | undefined;
+export declare function getWithdrawalScript(tx: Tx, index: number): Script<ScriptType> | undefined;
+export declare function getVotingScript(tx: Tx, index: number): Script<ScriptType> | undefined;
+export declare function getProposingScript(tx: Tx, index: number): Script<ScriptType> | undefined;

package/dist/TxBuilder/utils/getScript.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProposingScript = exports.getVotingScript = exports.getWithdrawalScript = exports.getCeritficateScript = exports.getMintingScript = exports.getSpendingScript = void 0;
+var cardano_ledger_ts_1 = require("@harmoniclabs/cardano-ledger-ts");
+var plutus_data_1 = require("@harmoniclabs/plutus-data");
+var uint8array_utils_1 = require("@harmoniclabs/uint8array-utils");
+function getScriptByHash(tx, hash) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    if (!(hash instanceof Uint8Array
+        && hash.length === 28))
+        return undefined;
+    var witnesses = tx.witnesses;
+    return ((_f = (_d = (_b = (_a = witnesses.plutusV1Scripts) === null || _a === void 0 ? void 0 : _a.find(function (s) { return (0, uint8array_utils_1.uint8ArrayEq)(hash, s.hash.toBuffer()); })) !== null && _b !== void 0 ? _b : (_c = witnesses.plutusV2Scripts) === null || _c === void 0 ? void 0 : _c.find(function (s) { return (0, uint8array_utils_1.uint8ArrayEq)(hash, s.hash.toBuffer()); })) !== null && _d !== void 0 ? _d : (_e = witnesses.plutusV3Scripts) === null || _e === void 0 ? void 0 : _e.find(function (s) { return (0, uint8array_utils_1.uint8ArrayEq)(hash, s.hash.toBuffer()); })) !== null && _f !== void 0 ? _f : (_h = (_g = tx.body.refInputs) === null || _g === void 0 ? void 0 : _g.find(function (i) { return i.resolved.refScript && (0, uint8array_utils_1.uint8ArrayEq)(hash, i.resolved.refScript.hash.toBuffer()); })) === null || _h === void 0 ? void 0 : _h.resolved.refScript);
+}
+function getSpendingScript(tx, index) {
+    var allScriptInputs = tx.body.inputs.filter(function (i) { return i.resolved.address.paymentCreds.type === cardano_ledger_ts_1.CredentialType.Script; });
+    if (allScriptInputs.length === 0)
+        return undefined;
+    var scriptInput = allScriptInputs[index];
+    var scriptHash = scriptInput.resolved.address.paymentCreds.hash.toBuffer();
+    var script = getScriptByHash(tx, scriptHash);
+    if (!script)
+        return undefined;
+    if ((0, plutus_data_1.isData)(scriptInput.resolved.datum))
+        return { script: script, datum: scriptInput.resolved.datum };
+    return { script: script, datum: undefined };
+}
+exports.getSpendingScript = getSpendingScript;
+function getMintingScript(tx, index) {
+    var mintedValue = tx.body.mint;
+    if (!mintedValue)
+        return undefined;
+    var allPolicies = mintedValue.map.map(function (entry) { return entry.policy; }).filter(function (p) { return p instanceof cardano_ledger_ts_1.Hash28; });
+    if (allPolicies.length === 0)
+        return undefined;
+    var policyHash = allPolicies[index];
+    return getScriptByHash(tx, policyHash.toBuffer());
+}
+exports.getMintingScript = getMintingScript;
+function getCeritficateScript(tx, index) {
+    var _a;
+    var allCertificates = tx.body.certs;
+    if (!allCertificates)
+        return undefined;
+    var cert = allCertificates[index];
+    if (!cert)
+        return undefined;
+    return getScriptByHash(tx, (_a = getCertStakeCreds(cert)) === null || _a === void 0 ? void 0 : _a.hash.toBuffer());
+}
+exports.getCeritficateScript = getCeritficateScript;
+function getWithdrawalScript(tx, index) {
+    var _a;
+    var allWithdrawals = tx.body.withdrawals;
+    if (!allWithdrawals)
+        return undefined;
+    var scriptHash = (_a = allWithdrawals.map[index]) === null || _a === void 0 ? void 0 : _a.rewardAccount.credentials.toBuffer();
+    if (!scriptHash)
+        return undefined;
+    return getScriptByHash(tx, scriptHash);
+}
+exports.getWithdrawalScript = getWithdrawalScript;
+function getVotingScript(tx, index) {
+    // TODO
+    return undefined;
+}
+exports.getVotingScript = getVotingScript;
+function getProposingScript(tx, index) {
+    // TODO
+    return undefined;
+}
+exports.getProposingScript = getProposingScript;
+function getCertStakeCreds(cert) {
+    // CertAuthCommitteeHot | CertResignCommitteeCold | CertRegistrationDrep | CertUnRegistrationDrep | CertUpdateDrep;
+    if (cert instanceof cardano_ledger_ts_1.CertStakeRegistration
+        || cert instanceof cardano_ledger_ts_1.CertStakeDeRegistration
+        || cert instanceof cardano_ledger_ts_1.CertStakeDelegation
+        || cert instanceof cardano_ledger_ts_1.CertVoteDeleg
+        || cert instanceof cardano_ledger_ts_1.CertStakeVoteDeleg
+        || cert instanceof cardano_ledger_ts_1.CertRegistrationDeposit
+        || cert instanceof cardano_ledger_ts_1.CertUnRegistrationDeposit
+        || cert instanceof cardano_ledger_ts_1.CertStakeRegistrationDeleg
+        || cert instanceof cardano_ledger_ts_1.CertVoteRegistrationDeleg
+        || cert instanceof cardano_ledger_ts_1.CertStakeVoteRegistrationDeleg)
+        return cert.stakeCredential;
+    if (cert instanceof cardano_ledger_ts_1.CertRegistrationDrep
+        || cert instanceof cardano_ledger_ts_1.CertUnRegistrationDrep
+        || cert instanceof cardano_ledger_ts_1.CertUpdateDrep)
+        return cert.drepCredential;
+    return undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@harmoniclabs/buildooor",
-    "version": "0.1.3",
+    "version": "0.1.5",
     "description": "Cardano transaction builder in typescript",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -54,7 +54,7 @@
         "@harmoniclabs/cardano-ledger-ts": "^0.3.2",
         "@harmoniclabs/cbor": "^1.6.0",
         "@harmoniclabs/pair": "^1.0.0",
-        "@harmoniclabs/plutus-data": "^1.2.4",
+        "@harmoniclabs/plutus-data": "^1.2.6",
         "@harmoniclabs/plutus-machine": "^2.1.0",
         "@harmoniclabs/uplc": "^1.4.0"
     },