@helios-lang/contract-utils 0.3.9 → 0.3.11

package/package.json

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

package/src/artifacts/ChildArtifactWriter.js

@@ -41,36 +41,49 @@ export class ChildArtifactWriter extends ArtifactWriter {
     /**
      * @param {string} name
      * @param {UplcProgram} program
+     * @param {boolean} includeDef
      * @returns {ChildArtifactWriter}
      */
-    writeProgram(name, program) {
+    writeProgram(name, program, includeDef) {
         if (program.plutusVersion == "PlutusScriptV1") {
             this.addImport("UplcProgramV1", "@helios-lang/uplc", true)
-            this.addImport("decodeUplcProgramV1FromCbor", "@helios-lang/uplc")
-
-            this.writeDeclLine(
-                `export const ${name}: UplcProgramV1`
-            ).writeDefLine(
-                `export const ${name} = ${stringifyProgram("decodeUplcProgramV1FromCbor", program)}`
-            )
+            this.writeDeclLine(`export const ${name}: UplcProgramV1`)
+
+            if (includeDef) {
+                this.addImport(
+                    "decodeUplcProgramV1FromCbor",
+                    "@helios-lang/uplc"
+                )
+                this.writeDefLine(
+                    `export const ${name} = ${stringifyProgram("decodeUplcProgramV1FromCbor", program)}`
+                )
+            }
         } else if (program.plutusVersion == "PlutusScriptV2") {
             this.addImport("UplcProgramV2", "@helios-lang/uplc", true)
-            this.addImport("decodeUplcProgramV2FromCbor", "@helios-lang/uplc")
-
-            this.writeDeclLine(
-                `export const ${name}: UplcProgramV2`
-            ).writeDefLine(
-                `export const ${name} = ${stringifyProgram("decodeUplcProgramV2FromCbor", program)}`
-            )
+            this.writeDeclLine(`export const ${name}: UplcProgramV2`)
+
+            if (includeDef) {
+                this.addImport(
+                    "decodeUplcProgramV2FromCbor",
+                    "@helios-lang/uplc"
+                )
+                this.writeDefLine(
+                    `export const ${name} = ${stringifyProgram("decodeUplcProgramV2FromCbor", program)}`
+                )
+            }
         } else if (program.plutusVersion == "PlutusScriptV3") {
             this.addImport("UplcProgramV3", "@helios-lang/uplc", true)
-            this.addImport("decodeUplcProgramV3FromCbor", "@helios-lang/uplc")
-
-            this.writeDeclLine(
-                `export const ${name}: UplcProgramV3`
-            ).writeDefLine(
-                `export const ${name} = ${stringifyProgram("decodeUplcProgramV3FromCbor", program)}`
-            )
+            this.writeDeclLine(`export const ${name}: UplcProgramV3`)
+
+            if (includeDef) {
+                this.addImport(
+                    "decodeUplcProgramV3FromCbor",
+                    "@helios-lang/uplc"
+                )
+                this.writeDefLine(
+                    `export const ${name} = ${stringifyProgram("decodeUplcProgramV3FromCbor", program)}`
+                )
+            }
         } else {
             throw new Error("unhandled Plutus version")
         }

package/src/artifacts/FunctionArtifact.js

@@ -1,11 +1,13 @@
+import { bytesToHex } from "@helios-lang/codec-utils"
+import { expectDefined, isRight } from "@helios-lang/type-utils"
 import {
-    genFuncType,
     genUserFuncArgsType,
     genUserFuncRetType
 } from "../codegen/LoadedScriptsWriter.js"
 import { ChildArtifactWriter } from "./ChildArtifactWriter.js"
 
 /**
+ * @import { UplcProgram } from "@helios-lang/uplc"
  * @import { UserFuncProps } from "../index.js"
  * @import { Artifact } from "./Artifact.js"
  * @import { FunctionDetails } from "./symbols.js"
@@ -22,9 +24,9 @@ export function writeFunctionArtifact(parent, name, details) {
     const program = details.uplc
     const props = details.props
 
-    artifact.writeProgram("$program", program)
+    artifact.writeProgram("$program", program, true)
     artifact.writeProps(props)
-    artifact.writeEvals(props)
+    artifact.writeEvals(program, props)
 
     artifact.save()
 
@@ -49,13 +51,15 @@ export const $props = ${JSON.stringify(props, undefined, 4)}`)
     }
 
     /**
+     * @param {UplcProgram} program
      * @param {UserFuncProps} props
      */
-    writeEvals(props) {
+    writeEvals(program, props) {
         const safeArgsType = genUserFuncArgsType(props)
         const unsafeArgsType = genUserFuncArgsType(props, true)
         const retType = genUserFuncRetType(props)
         const unsafeRetType = genUserFuncRetType(props, true)
+        const isConst = safeArgsType == "{}"
 
         this.addImport("UplcLogger", "@helios-lang/uplc", true)
         this.addImport("UplcData", "@helios-lang/uplc", true)
@@ -63,28 +67,66 @@ export const $props = ${JSON.stringify(props, undefined, 4)}`)
 
         this.addImport("evalUserFunc", "@helios-lang/contract-utils")
             .writeDeclLine(
-                `export function $eval(args${safeArgsType == "{}" ? "?" : ""}: ${safeArgsType}, logOptions?: UplcLogger | undefined): ${retType}`
+                `export function $eval(args${isConst ? "?" : ""}: ${safeArgsType}, logOptions?: UplcLogger | undefined): ${retType}`
             )
             .writeDefLine(
-                `export function $eval(args${safeArgsType == "{}" ? " = {}" : ""}, logOptions = undefined) {
+                `export function $eval(args${isConst ? " = {}" : ""}, logOptions = undefined) {
     return evalUserFunc($program, $props, args, logOptions)
 }`
             )
             .addImport("evalUserFuncUnsafe", "@helios-lang/contract-utils")
             .writeDeclLine(
-                `export function $evalUnsafe(args${unsafeArgsType == "{}" ? "?" : ""}: ${unsafeArgsType}, logOptions?: UplcLogger | undefined): ${unsafeRetType}`
+                `export function $evalUnsafe(args${isConst ? "?" : ""}: ${unsafeArgsType}, logOptions?: UplcLogger | undefined): ${unsafeRetType}`
             )
             .writeDefLine(
-                `export function $evalUnsafe(args${unsafeArgsType == "{}" ? " = {}" : ""}, logOptions = undefined) {
+                `export function $evalUnsafe(args${isConst ? " = {}" : ""}, logOptions = undefined) {
     return evalUserFuncUnsafe($program, $props, args, logOptions)
 }`
             )
             .addImport("profileUserFunc", "@helios-lang/contract-utils")
             .writeDeclLine(
-                `export function $profile(args${unsafeArgsType == "{}" ? "?" : ""}: ${unsafeArgsType}, logOptions?: UplcLogger | undefined): CekResult`
+                `export function $profile(args${isConst ? "?" : ""}: ${unsafeArgsType}, logOptions?: UplcLogger | undefined): CekResult`
             )
-            .writeDefLine(`export function $profile(args${unsafeArgsType == "{}" ? " = {}" : ""}, logOptions = undefined) {
+            .writeDefLine(`export function $profile(args${isConst ? " = {}" : ""}, logOptions = undefined) {
     return profileUserFunc($program, $props, args, logOptions)
 }`)
+
+        if (isConst) {
+            // attempt to evaluate, and add $data
+            try {
+                const result = program.eval([])
+
+                if (
+                    isRight(result.result) &&
+                    typeof result.result.right != "string" &&
+                    result.result.right.kind == "data"
+                ) {
+                    const data = result.result.right.value
+
+                    const uplcDataType = expectDefined(
+                        {
+                            int: "IntData",
+                            bytes: "ByteArrayData",
+                            constr: "ConstrData",
+                            map: "MapData",
+                            list: "ListData"
+                        }[data.kind]
+                    )
+
+                    this.addImport(uplcDataType, "@helios-lang/uplc", true)
+                        .writeDeclLine(
+                            `export const $constData: ${uplcDataType}`
+                        )
+                        .addImport("decodeUplcData", "@helios-lang/uplc", false)
+                        .writeDefLine(
+                            `export const $constData = /* @__PURE__ */ decodeUplcData("${bytesToHex(data.toCbor())}")`
+                        )
+
+                    // TODO: $constValue
+                }
+            } catch (_e) {
+                // don't do anything, simply ignore
+            }
+        }
     }
 }

package/src/artifacts/RootArtifact.js

@@ -16,6 +16,11 @@ export function writeContractContextArtifacts(context, options) {
 
     const root = new RootArtifact(options.fs, options.outDir, isMainnet)
 
+    /**
+     * @type {string[]}
+     */
+    let validatorNames = []
+
     for (let moduleName in context) {
         if (moduleName.startsWith("$")) {
             continue
@@ -30,11 +35,14 @@ export function writeContractContextArtifacts(context, options) {
                 moduleDetails.$hash,
                 moduleDetails
             )
+
+            validatorNames.push(moduleName)
         } else {
             writeModuleArtifact(root, moduleName, moduleDetails)
         }
     }
 
+    root.writeValidatorNameUtils(validatorNames)
     root.save()
 }
 
@@ -58,6 +66,27 @@ class RootArtifact extends ArtifactWriter {
 
         this.isMainnet = isMainnet
     }
+
+    /**
+     * @param {string[]} names
+     */
+    writeValidatorNameUtils(names) {
+        this.writeDeclLine(
+            `export type $ValidatorNameType = ${names.map((n) => `"${n}"`).join(" | ")}`
+        )
+            .writeDeclLine(
+                `export const $VALIDATOR_NAMES: $ValidatorNameType[]`
+            )
+            .writeDeclLine(
+                `export function $isValidatorName(name: string): name is $ValidatorNameType`
+            )
+            .writeDefLine(
+                `export const $VALIDATOR_NAMES = [${names.map((n) => `"${n}"`).join(", ")}]`
+            )
+            .writeDefLine(
+                `export function $isValidatorName(name) {return $VALIDATOR_NAMES.includes(name)}`
+            )
+    }
 }
 
 /**

package/src/artifacts/ValidatorArtifact.js

@@ -17,10 +17,10 @@ import { ModuleArtifact } from "./ModuleArtifact.js"
 export function writeValidatorArtifact(parent, name, hash, symbols) {
     const artifact = new ValdiatorArtifact(parent, name)
 
-    artifact.writeHash(hash)
-
     artifact.writeSymbols(symbols)
 
+    artifact.writeHash(hash)
+
     artifact.save()
 
     parent.writeAggregateExport(name)
@@ -30,19 +30,28 @@ export function writeValidatorArtifact(parent, name, hash, symbols) {
  * @implements {Artifact}
  */
 class ValdiatorArtifact extends ModuleArtifact {
+    /**
+     * @private
+     * @type {boolean}
+     */
+    hasMainFunction
+
     /**
      * @param {Artifact} parent
      * @param {string} name
      */
     constructor(parent, name) {
         super(parent, name)
+        this.hasMainFunction = false
     }
 
     /**
      * @param {ScriptHash} hash
      */
     writeHash(hash) {
-        // TODO: SpendingContext, MintingContext, StakingContext
+        this.writeDeclLine(`export const $hashHex: string`)
+        this.writeDefLine(`export const $hashHex = "${hash.toHex()}"`)
+
         if (hash.kind == "MintingPolicyHash") {
             this.addImport(
                 "MintingPolicyHash",
@@ -54,9 +63,15 @@ class ValdiatorArtifact extends ModuleArtifact {
                 this.writeDeclLine(
                     `export const $hash: MintingPolicyHash`
                 ).writeDefLine(
-                    `export const $hash = /* @__PURE__ */ makeMintingPolicyHash("${hash.toHex()}")`
+                    `export const $hash = /* @__PURE__ */ makeMintingPolicyHash($hashHex)`
                 )
             } else {
+                this.writeDeclLine(
+                    `export const $hashWithoutContext: MintingPolicyHash`
+                ).writeDefLine(
+                    `export const $hashWithoutContext = /* @__PURE__ */ makeMintingPolicyHash($hashHex)`
+                )
+
                 this.addImport("makeCast", "@helios-lang/contract-utils")
                 this.addImport("MintingContext", "@helios-lang/ledger", true)
 
@@ -70,10 +85,14 @@ class ValdiatorArtifact extends ModuleArtifact {
                 )
                 const types = genTypes(redeemer.schema)
 
-                this.writeProgram("$program", program).writeDeclLine(
-                    `export const $hash: MintingPolicyHash<MintingContext<${types[0]}, ${types[1]}>>`
+                this.writeProgram("$program", program, !this.hasMainFunction)
+
+                this.writeDeclLine(
+                    `export type $ContextType = MintingContext<${types[0]}, ${types[1]}>`
+                ).writeDeclLine(
+                    `export const $hash: MintingPolicyHash<$ContextType>`
                 )
-                    .writeDefLine(`export const $hash = /* @__PURE__ */ makeMintingPolicyHash("${hash.toHex()}", {
+                    .writeDefLine(`export const $hash = /* @__PURE__ */ makeMintingPolicyHash($hashHex, {
     program: $program,
     redeemer: /* @__PURE__*/ makeCast(${JSON.stringify(redeemer.schema, undefined, 4).split("\n").join("\n    ")}, {isMainnet: ${this.isMainnet}})
 })`)
@@ -89,9 +108,15 @@ class ValdiatorArtifact extends ModuleArtifact {
                 this.writeDeclLine(
                     `export const $hash: StakingValidatorHash`
                 ).writeDefLine(
-                    `export const $hash = /* @__PURE__*/ makeStakingValidatorHash("${hash.toHex()}")`
+                    `export const $hash = /* @__PURE__*/ makeStakingValidatorHash($hashHex)`
                 )
             } else {
+                this.writeDeclLine(
+                    `export const $hashWithoutContext: StakingValidatorHash`
+                ).writeDefLine(
+                    `export const $hashWithoutContext = /* @__PURE__*/ makeStakingValidatorHash($hashHex)`
+                )
+
                 this.addImport("makeCast", "@helios-lang/contract-utils")
                 this.addImport("StakingContext", "@helios-lang/ledger", true)
 
@@ -105,10 +130,14 @@ class ValdiatorArtifact extends ModuleArtifact {
                 )
                 const types = genTypes(redeemer.schema)
 
-                this.writeProgram("$program", program).writeDeclLine(
-                    `export const $hash: StakingValidatorHash<StakingContext<${types[0]}, ${types[1]}>>`
+                this.writeProgram("$program", program, !this.hasMainFunction)
+
+                this.writeDeclLine(
+                    `export type $ContextType = StakingContext<${types[0]}, ${types[1]}>`
+                ).writeDeclLine(
+                    `export const $hash: StakingValidatorHash<$ContextType>`
                 )
-                    .writeDefLine(`export const $hash = /* @__PURE__*/ makeStakingValidatorHash("${hash.toHex()}", {
+                    .writeDefLine(`export const $hash = /* @__PURE__*/ makeStakingValidatorHash($hashHex, {
     program: $program,
     redeemer: /* @__PURE__ */ makeCast(${JSON.stringify(redeemer.schema, undefined, 4).split("\n").join("\n    ")}, {isMainnet: ${this.isMainnet}})
 })`)
@@ -124,9 +153,15 @@ class ValdiatorArtifact extends ModuleArtifact {
                 this.writeDeclLine(
                     `export const $hash: ValidatorHash`
                 ).writeDefLine(
-                    `export const $hash = /* @__PURE__ */ makeValidatorHash("${hash.toHex()}")`
+                    `export const $hash = /* @__PURE__ */ makeValidatorHash($hashHex)`
                 )
             } else {
+                this.writeDeclLine(
+                    `export const $hashWithoutContext: ValidatorHash`
+                ).writeDefLine(
+                    `export const $hashWithoutContext = /* @__PURE__ */ makeValidatorHash($hashHex)`
+                )
+
                 this.addImport("makeCast", "@helios-lang/contract-utils")
                 this.addImport("SpendingContext", "@helios-lang/ledger", true)
 
@@ -144,15 +179,39 @@ class ValdiatorArtifact extends ModuleArtifact {
                 const dTypes = genTypes(datum.schema)
                 const rTypes = genTypes(redeemer.schema)
 
-                this.writeProgram("$program", program).writeDeclLine(
-                    `export const $hash: ValidatorHash<SpendingContext<${dTypes[0]}, ${dTypes[1]}, ${rTypes[0]}, ${rTypes[1]}>>`
+                this.writeProgram("$program", program, !this.hasMainFunction)
+
+                this.writeDeclLine(
+                    `export type $ContextType = SpendingContext<${dTypes[0]}, ${dTypes[1]}, ${rTypes[0]}, ${rTypes[1]}>`
                 )
-                    .writeDefLine(`export const $hash = /* @__PURE__ */ makeValidatorHash("${hash.toHex()}", {
+                    .writeDeclLine(
+                        `export const $hash: ValidatorHash<$ContextType>`
+                    )
+                    .writeDefLine(
+                        `export const $hash = /* @__PURE__ */ makeValidatorHash($hashHex, {
     program: $program,
     datum: /* @__PURE__ */ makeCast(${JSON.stringify(datum.schema, undefined, 4).split("\n").join("\n    ")}, {isMainnet: ${this.isMainnet}}),
     redeemer: /* @__PURE__ */ makeCast(${JSON.stringify(redeemer.schema, undefined, 4).split("\n").join("\n    ")}, {isMainnet: ${this.isMainnet}})
-})`)
+})`
+                    )
             }
         }
     }
+
+    /**
+     * @param {string} name
+     * @returns {ValdiatorArtifact}
+     */
+    writeAggregateExport(name) {
+        super.writeAggregateExport(name)
+
+        if (name == "main") {
+            this.writeDefLine(
+                `import { $program } from "./${name}/index.js"`
+            ).writeDefLine(`export { $program }`)
+            this.hasMainFunction = true
+        }
+
+        return this
+    }
 }

package/types/artifacts/ChildArtifactWriter.d.ts

@@ -25,9 +25,10 @@ export class ChildArtifactWriter extends ArtifactWriter {
     /**
      * @param {string} name
      * @param {UplcProgram} program
+     * @param {boolean} includeDef
      * @returns {ChildArtifactWriter}
      */
-    writeProgram(name: string, program: UplcProgram): ChildArtifactWriter;
+    writeProgram(name: string, program: UplcProgram, includeDef: boolean): ChildArtifactWriter;
 }
 import { ArtifactWriter } from "./ArtifactWriter.js";
 import type { Artifact } from "./Artifact.js";

package/types/artifacts/ChildArtifactWriter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChildArtifactWriter.d.ts","sourceRoot":"","sources":["../../src/artifacts/ChildArtifactWriter.js"],"names":[],"mappings":"AAIA;;;GAGG;AAEH;IAaI;;;OAGG;IACH,oBAHW,QAAQ,QACR,MAAM,EAOhB;IArBD;;;OAGG;IACH,iBAFU,QAAQ,CAEZ;IAEN;;;OAGG;IACH,eAFU,MAAM,CAEZ;IAaJ;;OAEG;IACH,iBAFU,OAAO,CAIhB;IAED;;;;OAIG;IACH,mBAJW,MAAM,WACN,WAAW,GACT,mBAAmB,CAmC/B;CACJ;+BA7E8B,qBAAqB;8BAIvB,eAAe;iCADZ,mBAAmB"}
+{"version":3,"file":"ChildArtifactWriter.d.ts","sourceRoot":"","sources":["../../src/artifacts/ChildArtifactWriter.js"],"names":[],"mappings":"AAIA;;;GAGG;AAEH;IAaI;;;OAGG;IACH,oBAHW,QAAQ,QACR,MAAM,EAOhB;IArBD;;;OAGG;IACH,iBAFU,QAAQ,CAEZ;IAEN;;;OAGG;IACH,eAFU,MAAM,CAEZ;IAaJ;;OAEG;IACH,iBAFU,OAAO,CAIhB;IAED;;;;;OAKG;IACH,mBALW,MAAM,WACN,WAAW,cACX,OAAO,GACL,mBAAmB,CA+C/B;CACJ;+BA1F8B,qBAAqB;8BAIvB,eAAe;iCADZ,mBAAmB"}

package/types/artifacts/FunctionArtifact.d.ts

@@ -1,4 +1,5 @@
 /**
+ * @import { UplcProgram } from "@helios-lang/uplc"
  * @import { UserFuncProps } from "../index.js"
  * @import { Artifact } from "./Artifact.js"
  * @import { FunctionDetails } from "./symbols.js"

package/types/artifacts/FunctionArtifact.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FunctionArtifact.d.ts","sourceRoot":"","sources":["../../src/artifacts/FunctionArtifact.js"],"names":[],"mappings":"AAOA;;;;GAIG;AAEH;;;;GAIG;AACH,8CAJW,QAAQ,QACR,MAAM,WACN,eAAe,QAezB;8BAtB4B,eAAe;qCACR,cAAc"}
+{"version":3,"file":"FunctionArtifact.d.ts","sourceRoot":"","sources":["../../src/artifacts/FunctionArtifact.js"],"names":[],"mappings":"AAQA;;;;;GAKG;AAEH;;;;GAIG;AACH,8CAJW,QAAQ,QACR,MAAM,WACN,eAAe,QAezB;8BAtB4B,eAAe;qCACR,cAAc"}

package/types/artifacts/RootArtifact.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RootArtifact.d.ts","sourceRoot":"","sources":["../../src/artifacts/RootArtifact.js"],"names":[],"mappings":"AAIA;;;GAGG;AAEH;;;GAGG;AACH,uDAHW,GAAG,WACH,oCAAoC,QA2B9C;0DAjCyJ,aAAa"}
+{"version":3,"file":"RootArtifact.d.ts","sourceRoot":"","sources":["../../src/artifacts/RootArtifact.js"],"names":[],"mappings":"AAIA;;;GAGG;AAEH;;;GAGG;AACH,uDAHW,GAAG,WACH,oCAAoC,QAmC9C;0DAzCyJ,aAAa"}