@helios-lang/contract-utils 0.2.34 → 0.2.35

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@helios-lang/contract-utils",
-    "version": "0.2.34",
+    "version": "0.2.35",
     "description": "Convenience and type-safety utilities for using Helios validators from within Typescript",
     "main": "src/index.js",
     "types": "types/index.d.ts",

package/src/cast/UserFunc.js

@@ -4,6 +4,7 @@ import { Cast } from "./Cast.js"
 
 /**
  * @typedef {import("@helios-lang/type-utils").TypeSchema} TypeSchema
+ * @typedef {import("@helios-lang/uplc").CekResult} CekResult
  * @typedef {import("@helios-lang/uplc").UplcData} UplcData
  * @typedef {import("@helios-lang/uplc").UplcProgram} UplcProgram
  * @typedef {import("@helios-lang/uplc").UplcValue} UplcValue
@@ -102,6 +103,22 @@ export class UserFunc {
      * @returns {UplcData}
      */
     evalUnsafe(namedArgs) {
+        const result = this.profile(namedArgs).result
+
+        if (isLeft(result)) {
+            throw new Error(result.left.error)
+        } else if (result.right instanceof UplcDataValue) {
+            return result.right.value
+        } else {
+            throw new Error(`${result.right.toString()} isn't a UplcDataValue`)
+        }
+    }
+
+    /**
+     * @param {UnsafeArgsT<ArgsT>} namedArgs
+     * @returns {CekResult}
+     */
+    profile(namedArgs) {
         /**
          * @type {UplcData[]}
          */
@@ -113,10 +130,7 @@ export class UserFunc {
                     return new ConstrData(1, [])
                 }
             } else {
-                const rawArg = expectSome(namedArgs[name])
-
-                // TODO: apply type conversion
-                return rawArg
+                return expectSome(namedArgs[name])
             }
         })
 
@@ -132,32 +146,50 @@ export class UserFunc {
             const index = expectSome(
                 expectSome(this.props.validatorIndices)[currentScriptName]
             )
+
             args.push(new ConstrData(index, []))
         }
 
         const argValues = args.map((a) => new UplcDataValue(a))
 
-        const result = this.uplc.eval(argValues).result
+        const cekResult = this.uplc.eval(argValues)
 
         if ("alt" in this.uplc && this.uplc.alt instanceof UplcProgramV2) {
-            const resultUnoptim = this.uplc.alt.eval(argValues).result
+            const cekResultUnoptim = this.uplc.alt.eval(argValues)
+            const resultUnoptim = cekResultUnoptim.result
             const resultUnoptimStr = evalResultToString(resultUnoptim)
-            const resultStr = evalResultToString(result)
+            const resultStr = evalResultToString(cekResult.result)
 
             if (resultStr != resultUnoptimStr) {
                 throw new Error(
                     `Critical error: contact Helios maintainers, expected ${resultUnoptimStr}, got ${resultStr}`
                 )
             }
-        }
 
-        if (isLeft(result)) {
-            throw new Error(result.left.error)
-        } else if (result.right instanceof UplcDataValue) {
-            return result.right.value
-        } else {
-            throw new Error(`${result.right.toString()} isn't a UplcDataValue`)
+            // also make sure the cost is an improvement
+            if (cekResult.cost.mem > cekResultUnoptim.cost.mem) {
+                throw new Error(
+                    `Critical error: optimizer worsened memory cost of ${this.props.name}`
+                )
+            }
+
+            if (cekResult.cost.cpu > cekResultUnoptim.cost.cpu) {
+                throw new Error(
+                    `Critical error: optimizer worsened cpu cost of ${this.props.name}`
+                )
+            }
+
+            if (
+                cekResult.cost.mem == cekResultUnoptim.cost.mem &&
+                cekResult.cost.cpu == cekResultUnoptim.cost.cpu
+            ) {
+                console.error(
+                    `Warning: optimizer didn't improve cost of ${this.props.name}`
+                )
+            }
         }
+
+        return cekResult
     }
 }
 

package/src/codegen/TypeCheckedModule.js

@@ -6,6 +6,7 @@ export {}
 
 /**
  * @typedef {{
+ *   name: string
  *   requiresScriptContext: boolean
  *   requiresCurrentScript: boolean
  *   arguments: {

package/types/cast/UserFunc.d.ts

@@ -1,5 +1,6 @@
 /**
  * @typedef {import("@helios-lang/type-utils").TypeSchema} TypeSchema
+ * @typedef {import("@helios-lang/uplc").CekResult} CekResult
  * @typedef {import("@helios-lang/uplc").UplcData} UplcData
  * @typedef {import("@helios-lang/uplc").UplcProgram} UplcProgram
  * @typedef {import("@helios-lang/uplc").UplcValue} UplcValue
@@ -58,8 +59,14 @@ export class UserFunc<ArgsT extends {
      * @returns {UplcData}
      */
     evalUnsafe(namedArgs: UnsafeArgsT<ArgsT>): UplcData;
+    /**
+     * @param {UnsafeArgsT<ArgsT>} namedArgs
+     * @returns {CekResult}
+     */
+    profile(namedArgs: UnsafeArgsT<ArgsT>): CekResult;
 }
 export type TypeSchema = import("@helios-lang/type-utils").TypeSchema;
+export type CekResult = import("@helios-lang/uplc").CekResult;
 export type UplcData = import("@helios-lang/uplc").UplcData;
 export type UplcProgram = import("@helios-lang/uplc").UplcProgram;
 export type UplcValue = import("@helios-lang/uplc").UplcValue;

package/types/cast/UserFunc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserFunc.d.ts","sourceRoot":"","sources":["../../src/cast/UserFunc.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;GAGG;AAEH;;;GAGG;AACH;;;IAeI;;;OAGG;IACH,kBAHW,WAAW,SACX,aAAa,EAKvB;IArBD;;;;OAIG;IACH,sBAAI;IAEJ;;;;OAIG;IACH,uBAAK;IAWL;;;OAGG;IACH,gBAHW,KAAK,GACH,IAAI,CAkChB;IAED;;;OAGG;IACH,sBAHW,YAAY,KAAK,CAAC,GAChB,QAAQ,CA2DpB;CACJ;yBA5JY,OAAO,yBAAyB,EAAE,UAAU;uBAC5C,OAAO,mBAAmB,EAAE,QAAQ;0BACpC,OAAO,mBAAmB,EAAE,WAAW;wBACvC,OAAO,mBAAmB,EAAE,SAAS;yBACrC,OAAO,WAAW,EAAE,UAAU;4BAI9B;IACZ,MAAU,MAAM,CAAA;IAChB,qBAAyB,EAAE,OAAO,CAAA;IAClC,qBAAyB,EAAE,OAAO,CAAA;IAClC,SAAa,EAAE;QACf,MAAY,MAAM,CAAA;QAClB,IAAU,EAAE,UAAU,CAAA;QACtB,UAAgB,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IACP,OAAW,EAAE,UAAU,CAAA;IACvB,gBAAoB,CAAC,EAAE,OAAO,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,UAAc,EAAE,UAAU,CAAA;CACvB"}
+{"version":3,"file":"UserFunc.d.ts","sourceRoot":"","sources":["../../src/cast/UserFunc.js"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;GAGG;AAEH;;;GAGG;AACH;;;IAeI;;;OAGG;IACH,kBAHW,WAAW,SACX,aAAa,EAKvB;IArBD;;;;OAIG;IACH,sBAAI;IAEJ;;;;OAIG;IACH,uBAAK;IAWL;;;OAGG;IACH,gBAHW,KAAK,GACH,IAAI,CAkChB;IAED;;;OAGG;IACH,sBAHW,YAAY,KAAK,CAAC,GAChB,QAAQ,CAYpB;IAED;;;OAGG;IACH,mBAHW,YAAY,KAAK,CAAC,GAChB,SAAS,CA0ErB;CACJ;yBA5LY,OAAO,yBAAyB,EAAE,UAAU;wBAC5C,OAAO,mBAAmB,EAAE,SAAS;uBACrC,OAAO,mBAAmB,EAAE,QAAQ;0BACpC,OAAO,mBAAmB,EAAE,WAAW;wBACvC,OAAO,mBAAmB,EAAE,SAAS;yBACrC,OAAO,WAAW,EAAE,UAAU;4BAI9B;IACZ,MAAU,MAAM,CAAA;IAChB,qBAAyB,EAAE,OAAO,CAAA;IAClC,qBAAyB,EAAE,OAAO,CAAA;IAClC,SAAa,EAAE;QACf,MAAY,MAAM,CAAA;QAClB,IAAU,EAAE,UAAU,CAAA;QACtB,UAAgB,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IACP,OAAW,EAAE,UAAU,CAAA;IACvB,gBAAoB,CAAC,EAAE,OAAO,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,UAAc,EAAE,UAAU,CAAA;CACvB"}

package/types/codegen/TypeCheckedModule.d.ts

@@ -1,5 +1,6 @@
 export type TypeSchema = import("./TypeSchema.js").TypeSchema;
 export type TypeCheckedUserFunc = {
+    name: string;
     requiresScriptContext: boolean;
     requiresCurrentScript: boolean;
     arguments: {

package/types/codegen/TypeCheckedModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TypeCheckedModule.d.ts","sourceRoot":"","sources":["../../src/codegen/TypeCheckedModule.js"],"names":[],"mappings":"yBAGa,OAAO,iBAAiB,EAAE,UAAU;kCAIpC;IACZ,qBAAyB,EAAE,OAAO,CAAA;IAClC,qBAAyB,EAAE,OAAO,CAAA;IAClC,SAAa,EAAE;QACf,MAAY,MAAM,CAAA;QAClB,IAAU,EAAE,UAAU,CAAA;QACtB,UAAgB,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IACP,OAAW,EAAE,UAAU,CAAA;CACpB;gCAIS;IACZ,MAAU,MAAM,CAAA;IAChB,OAAW,EAAE,MAAM,CAAA;IACnB,UAAc,EAAE,MAAM,CAAA;IACtB,iBAAqB,EAAE,MAAM,EAAE,CAAA;IAC/B,KAAS,EAAE,OAAO,MAAM,EAAE,UAAU,CAAC,CAAA;IACrC,SAAa,CAAC,EAAE,OAAO,MAAM,EAAE,mBAAmB,CAAC,CAAA;CAChD"}
+{"version":3,"file":"TypeCheckedModule.d.ts","sourceRoot":"","sources":["../../src/codegen/TypeCheckedModule.js"],"names":[],"mappings":"yBAGa,OAAO,iBAAiB,EAAE,UAAU;kCAIpC;IACZ,MAAU,MAAM,CAAA;IAChB,qBAAyB,EAAE,OAAO,CAAA;IAClC,qBAAyB,EAAE,OAAO,CAAA;IAClC,SAAa,EAAE;QACf,MAAY,MAAM,CAAA;QAClB,IAAU,EAAE,UAAU,CAAA;QACtB,UAAgB,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IACP,OAAW,EAAE,UAAU,CAAA;CACpB;gCAIS;IACZ,MAAU,MAAM,CAAA;IAChB,OAAW,EAAE,MAAM,CAAA;IACnB,UAAc,EAAE,MAAM,CAAA;IACtB,iBAAqB,EAAE,MAAM,EAAE,CAAA;IAC/B,KAAS,EAAE,OAAO,MAAM,EAAE,UAAU,CAAC,CAAA;IACrC,SAAa,CAAC,EAAE,OAAO,MAAM,EAAE,mBAAmB,CAAC,CAAA;CAChD"}