@helios-lang/contract-utils 0.2.81 → 0.3.0

package/src/compiler/CompilerLib_v0_17.js

@@ -1,15 +1,9 @@
 import { bytesToHex } from "@helios-lang/codec-utils"
-import { None } from "@helios-lang/type-utils"
-import { UplcSourceMap } from "@helios-lang/uplc"
+import { makeUplcSourceMap } from "@helios-lang/uplc"
 
 /**
- * @typedef {import("@helios-lang/uplc").UplcData} UplcData
- * @typedef {import("@helios-lang/uplc").UplcProgramV2I} UplcProgramV2I
- * @typedef {import("./CompilerLib.js").CompilerLib} CompilerLib
- * @typedef {import("./CompilerLib.js").CompileOptions} CompileOptions
- * @typedef {import("./CompilerLib.js").CompileOutput} CompileOutput
- * @typedef {import("./CompilerLib.js").ScriptHashType} ScriptHashType
- * @typedef {import("./CompilerLib.js").TypeCheckOutput} TypeCheckOutput
+ * @import { UplcData, UplcProgramV2 } from "@helios-lang/uplc"
+ * @import { CompilerLib, CompileOptions, CompileOutput, ScriptHashType, TypeCheckOutput } from "../index.js"
  */
 
 /**
@@ -23,15 +17,23 @@ import { UplcSourceMap } from "@helios-lang/uplc"
  *     hashDependencies?: Record<string, string>
  *     validatorIndices?: Record<string, number>
  *     excludeUserFuncs?: Set<string>
- *     onCompileUserFunc?: (name: string, uplc: UplcProgramV2I) => void
- *   }): UplcProgramV2I
+ *     onCompileUserFunc?: (name: string, uplc: UplcProgramV2) => void
+ *   }): UplcProgramV2
  * }} Program
  */
 
+/**
+ * @param {any} lib
+ * @returns {CompilerLib}
+ */
+export function makeCompilerLib_v0_17(lib) {
+    return new CompilerLib_v0_17(lib)
+}
+
 /**
  * @implements {CompilerLib}
  */
-export class CompilerLib_v0_17 {
+class CompilerLib_v0_17 {
     /**
      * @private
      * @type {any}
@@ -90,7 +92,7 @@ export class CompilerLib_v0_17 {
         const onCompileUserFunc = options.onCompileUserFunc
 
         /**
-         * @type {UplcProgramV2I}
+         * @type {UplcProgramV2}
          */
         const uplc = program.compile({
             optimize: options.optimize,
@@ -109,16 +111,16 @@ export class CompilerLib_v0_17 {
                 ? {
                       onCompileUserFunc: (name, uplc) => {
                           const alt = uplc.alt
-                          const ir = options.debug ? uplc.ir : None
-                          const altIr = options.debug ? alt?.ir : None
-                          const sourceMap = UplcSourceMap.fromUplcTerm(
-                              uplc.root
-                          ).toJsonSafe()
+                          const ir = options.debug ? uplc.ir : undefined
+                          const altIr = options.debug ? alt?.ir : undefined
+                          const sourceMap = makeUplcSourceMap({
+                              term: uplc.root
+                          }).toJsonSafe()
                           const altSourceMap = alt
-                              ? UplcSourceMap.fromUplcTerm(
-                                    alt.root
-                                ).toJsonSafe()
-                              : None
+                              ? makeUplcSourceMap({
+                                    term: alt.root
+                                }).toJsonSafe()
+                              : undefined
 
                           onCompileUserFunc({
                               name: name,
@@ -153,7 +155,7 @@ export class CompilerLib_v0_17 {
                 : {})
         })
 
-        const sourceMap = UplcSourceMap.fromUplcTerm(uplc.root)
+        const sourceMap = makeUplcSourceMap({ term: uplc.root })
 
         return {
             cborHex: bytesToHex(uplc.toCbor()),

package/src/compiler/index.js

@@ -1,6 +1 @@
 export { loadCompilerLib, typeCheckFiles, typeCheckScripts } from "./ops.js"
-
-/**
- * @typedef {import("./CompilerLib.js").CompilerLib} CompilerLib
- * @typedef {import("./CompilerLib.js").TypeCheckOutput} TypeCheckOutput
- */

package/src/compiler/ops.js

@@ -3,13 +3,11 @@ import {
     translateImportPaths as translateImportPathsInternal,
     readHeader
 } from "@helios-lang/compiler-utils"
-import { CompilerLib_v0_16 } from "./CompilerLib_v0_16.js"
-import { CompilerLib_v0_17 } from "./CompilerLib_v0_17.js"
+import { makeCompilerLib_v0_16 } from "./CompilerLib_v0_16.js"
+import { makeCompilerLib_v0_17 } from "./CompilerLib_v0_17.js"
 
 /**
- * @typedef {import("./CompilerLib.js").CompilerLib} CompilerLib
- * @typedef {import("./CompilerLib.js")}
- * @typedef {import("./CompilerLib.js").TypeCheckOutput} TypeCheckOutput
+ * @import { CompilerLib, TypeCheckOutput } from "../index.js"
  */
 
 /**
@@ -31,9 +29,9 @@ export function loadCompilerLib() {
         case 0:
             switch (minor) {
                 case 16:
-                    return new CompilerLib_v0_16(unsafeLib)
+                    return makeCompilerLib_v0_16(unsafeLib)
                 case 17:
-                    return new CompilerLib_v0_17(unsafeLib)
+                    return makeCompilerLib_v0_17(unsafeLib)
             }
         default:
             throw new Error(

package/src/context/CacheEntry.js

@@ -1,26 +1,21 @@
 import { bytesToHex } from "@helios-lang/codec-utils"
 import {
-    MintingPolicyHash,
-    ScriptHash,
-    StakingValidatorHash,
-    ValidatorHash
+    makeMintingPolicyHash,
+    makeStakingValidatorHash,
+    makeValidatorHash
 } from "@helios-lang/ledger"
-import { None, expectSome } from "@helios-lang/type-utils"
-import { UplcProgramV1, UplcProgramV2, UplcSourceMap } from "@helios-lang/uplc"
-import { Cast } from "../cast/Cast.js"
+import { expectDefined } from "@helios-lang/type-utils"
+import {
+    decodeUplcProgramV1FromCbor,
+    decodeUplcProgramV2FromCbor,
+    makeUplcSourceMap
+} from "@helios-lang/uplc"
+import { makeCast } from "../cast/Cast.js"
 
 /**
- * @typedef {import("@helios-lang/type-utils").TypeSchema} TypeSchema
- * @typedef {import("@helios-lang/uplc").UplcData} UplcData
- * @typedef {import("@helios-lang/uplc").PlutusVersion} PlutusVersion
- * @typedef {import("@helios-lang/uplc").UplcProgram} UplcProgram
- * @typedef {import("@helios-lang/uplc").UplcProgramV1I} UplcProgramV1I
- * @typedef {import("@helios-lang/uplc").UplcProgramV2I} UplcProgramV2I
- * @typedef {import("@helios-lang/uplc").UplcSourceMapJsonSafe} UplcSourceMapJsonSafe
- * @typedef {import("../cast/index.js").CastConfig} CastConfig
- * @typedef {import("../codegen/LoadedModule.js").LoadedModule} LoadedModule
- * @typedef {import("../codegen/LoadedValidator.js").LoadedValidator} LoadedValidator
- * @typedef {import("./ContractContext.js").AnyContractValidatorContext} AnyContractValidatorContext
+ * @import { TypeSchema } from "@helios-lang/type-utils"
+ * @import { PlutusVersion, UplcData, UplcProgram, UplcProgramV1, UplcProgramV2, UplcSourceMapJsonSafe } from "@helios-lang/uplc"
+ * @import { AnyContractValidatorContext, Cast, CastConfig, LoadedModule, LoadedValidator } from "../index.js"
  */
 
 /**
@@ -87,33 +82,57 @@ export function cacheEntryToJsonSafe(entry) {
         const hash = entry.validators[name]
 
         const purpose =
-            hash instanceof ValidatorHash
+            hash.kind == "ValidatorHash"
                 ? "spending"
-                : hash instanceof MintingPolicyHash
+                : hash.kind == "MintingPolicyHash"
                   ? "minting"
-                  : hash instanceof StakingValidatorHash
+                  : hash.kind == "StakingValidatorHash"
                     ? "staking"
-                    : hash instanceof ScriptHash
-                      ? "mixed"
-                      : "unknown"
-        if (purpose == "unknown") {
-            throw new Error("unhandled hash type")
+                    : "mixed"
+
+        const context = hash.context
+
+        if (
+            !(
+                typeof hash.context == "object" &&
+                hash.context !== null &&
+                "redeemer" in hash.context &&
+                "program" in hash.context
+            )
+        ) {
+            throw new Error("invalid context")
         }
 
-        const redeemer =
-            hash.context.redeemer instanceof Cast ? hash.context.redeemer : None
+        /**
+         * @type {Cast<any, any> | undefined}
+         */
+        const redeemer = /** @type {any} */ (
+            typeof hash.context.redeemer == "object" &&
+            hash.context.redeemer !== null &&
+            "kind" in hash.context.redeemer &&
+            hash.context.redeemer.kind == "Cast"
+                ? hash.context.redeemer
+                : undefined
+        )
 
         if (!redeemer) {
             throw new Error("Redeemer is not a Cast type")
         }
 
         /**
-         * @type {Option<Cast>}
+         * @type {Cast<any, any> | undefined}
          */
-        let datum = None
+        let datum = undefined
 
-        if (hash.context.datum && hash.context.datum instanceof Cast) {
-            datum = hash.context.datum
+        if (
+            "datum" in hash.context &&
+            hash.context.datum &&
+            typeof hash.context.datum == "object" &&
+            hash.context.datum !== null &&
+            "kind" in hash.context.datum &&
+            hash.context.datum.kind == "Cast"
+        ) {
+            datum = /** @type {any} */ (hash.context.datum)
         }
 
         if (["spending", "mixed"].includes(purpose) && !datum) {
@@ -121,9 +140,9 @@ export function cacheEntryToJsonSafe(entry) {
         }
 
         /**
-         * @type {UplcProgramV1I | UplcProgramV2I}
+         * @type {UplcProgramV1 | UplcProgramV2}
          */
-        const program = hash.context.program
+        const program = /** @type {any} */ (hash.context.program)
 
         resValidators[name] = {
             purpose: purpose,
@@ -132,17 +151,16 @@ export function cacheEntryToJsonSafe(entry) {
             unoptimizedCborHex: program.alt
                 ? bytesToHex(program.alt.toCbor())
                 : undefined,
-            optimizedIr:
-                /** @type {UplcProgramV2I} */ (program).ir ?? undefined,
+            optimizedIr: /** @type {UplcProgramV2} */ (program).ir ?? undefined,
             unoptimizedIr:
-                /** @type {UplcProgramV2I} */ (program).alt?.ir ?? undefined,
-            optimizedSourceMap: UplcSourceMap.fromUplcTerm(
-                program.root
-            ).toJsonSafe(),
+                /** @type {UplcProgramV2} */ (program).alt?.ir ?? undefined,
+            optimizedSourceMap: makeUplcSourceMap({
+                term: program.root
+            }).toJsonSafe(),
             unoptimizedSourceMap: program.alt
-                ? UplcSourceMap.fromUplcTerm(program.alt.root).toJsonSafe()
+                ? makeUplcSourceMap({ term: program.alt.root }).toJsonSafe()
                 : undefined,
-            plutusVersion: hash.context.program.plutusVersion,
+            plutusVersion: program.plutusVersion,
             castConfig: redeemer.config,
             redeemer: redeemer.schema,
             datum: datum?.schema
@@ -154,18 +172,18 @@ export function cacheEntryToJsonSafe(entry) {
 
         resUserFuncs[name] = {
             optimizedCborHex: bytesToHex(userFunc.toCbor()),
-            unoptimizedCborHex: /** @type {UplcProgramV2I} */ (userFunc).alt
+            unoptimizedCborHex: /** @type {UplcProgramV2} */ (userFunc).alt
                 ? bytesToHex(
-                      /** @type {UplcProgramV2I} */ (userFunc).alt.toCbor()
+                      /** @type {UplcProgramV2} */ (userFunc).alt.toCbor()
                   )
                 : undefined,
             optimizedIr: userFunc.ir ?? undefined,
             unoptimizedIr: userFunc.alt?.ir ?? undefined,
-            optimizedSourceMap: UplcSourceMap.fromUplcTerm(
-                userFunc.root
-            ).toJsonSafe(),
+            optimizedSourceMap: makeUplcSourceMap({
+                term: userFunc.root
+            }).toJsonSafe(),
             unoptimizedSourceMap: userFunc.alt
-                ? UplcSourceMap.fromUplcTerm(userFunc.alt.root).toJsonSafe()
+                ? makeUplcSourceMap({ term: userFunc.alt.root }).toJsonSafe()
                 : undefined,
             plutusVersion: userFunc.plutusVersion
         }
@@ -200,11 +218,11 @@ export function cacheEntryFromJson(entry) {
          */
         let program =
             props.plutusVersion == "PlutusScriptV1"
-                ? UplcProgramV1.fromCbor(props.optimizedCborHex, {
+                ? decodeUplcProgramV1FromCbor(props.optimizedCborHex, {
                       ir: props.optimizedIr,
                       sourceMap: props.optimizedSourceMap
                   })
-                : UplcProgramV2.fromCbor(props.optimizedCborHex, {
+                : decodeUplcProgramV2FromCbor(props.optimizedCborHex, {
                       ir: props.optimizedIr,
                       sourceMap: props.optimizedSourceMap
                   })
@@ -212,14 +230,14 @@ export function cacheEntryFromJson(entry) {
         if (props.unoptimizedCborHex) {
             if (program.plutusVersion == "PlutusScriptV1") {
                 program = program.withAlt(
-                    UplcProgramV1.fromCbor(props.unoptimizedCborHex, {
+                    decodeUplcProgramV1FromCbor(props.unoptimizedCborHex, {
                         ir: props.unoptimizedIr,
                         sourceMap: props.unoptimizedSourceMap
                     })
                 )
             } else if (program.plutusVersion == "PlutusScriptV2") {
                 program = program.withAlt(
-                    UplcProgramV2.fromCbor(props.unoptimizedCborHex, {
+                    decodeUplcProgramV2FromCbor(props.unoptimizedCborHex, {
                         ir: props.unoptimizedIr,
                         sourceMap: props.unoptimizedSourceMap
                     })
@@ -229,37 +247,41 @@ export function cacheEntryFromJson(entry) {
             }
         }
 
-        let redeemer = new Cast(props.redeemer, props.castConfig)
+        let redeemer = makeCast(props.redeemer, props.castConfig)
 
         switch (props.purpose) {
             case "spending": {
-                res.validators[name] = new ValidatorHash(props.bytes, {
-                    datum: new Cast(expectSome(props.datum), props.castConfig),
+                res.validators[name] = makeValidatorHash(props.bytes, {
+                    datum: makeCast(
+                        expectDefined(props.datum),
+                        props.castConfig
+                    ),
                     redeemer: redeemer,
                     program: program
                 })
                 break
             }
             case "minting": {
-                res.validators[name] = new MintingPolicyHash(props.bytes, {
+                res.validators[name] = makeMintingPolicyHash(props.bytes, {
                     redeemer: redeemer,
                     program: program
                 })
                 break
             }
             case "staking": {
-                res.validators[name] = new StakingValidatorHash(props.bytes, {
+                res.validators[name] = makeStakingValidatorHash(props.bytes, {
                     redeemer: redeemer,
                     program: program
                 })
                 break
             }
             case "mixed": {
-                res.validators[name] = new ScriptHash(props.bytes, {
-                    datum: new Cast(expectSome(props.datum), props.castConfig),
+                throw new Error("implement ScriptHash type")
+                /*res.validators[name] = new ScriptHash(props.bytes, {
+                    datum: makeCast(expectDefined(props.datum), props.castConfig),
                     redeemer: redeemer,
                     program: program
-                })
+                })*/
                 break
             }
             default:
@@ -275,11 +297,11 @@ export function cacheEntryFromJson(entry) {
          */
         let program =
             props.plutusVersion == "PlutusScriptV1"
-                ? UplcProgramV1.fromCbor(props.optimizedCborHex, {
+                ? decodeUplcProgramV1FromCbor(props.optimizedCborHex, {
                       ir: props.optimizedIr,
                       sourceMap: props.optimizedSourceMap
                   })
-                : UplcProgramV2.fromCbor(props.optimizedCborHex, {
+                : decodeUplcProgramV2FromCbor(props.optimizedCborHex, {
                       ir: props.optimizedIr,
                       sourceMap: props.optimizedSourceMap
                   })
@@ -287,14 +309,14 @@ export function cacheEntryFromJson(entry) {
         if (props.unoptimizedCborHex) {
             if (program.plutusVersion == "PlutusScriptV1") {
                 program = program.withAlt(
-                    UplcProgramV1.fromCbor(props.unoptimizedCborHex, {
+                    decodeUplcProgramV1FromCbor(props.unoptimizedCborHex, {
                         ir: props.unoptimizedIr,
                         sourceMap: props.unoptimizedSourceMap
                     })
                 )
             } else if (program.plutusVersion == "PlutusScriptV2") {
                 program = program.withAlt(
-                    UplcProgramV2.fromCbor(props.unoptimizedCborHex, {
+                    decodeUplcProgramV2FromCbor(props.unoptimizedCborHex, {
                         ir: props.unoptimizedIr,
                         sourceMap: props.unoptimizedSourceMap
                     })

package/src/context/ContractContextBuilder.js

@@ -1,44 +1,27 @@
-import { expectSome } from "@helios-lang/type-utils"
+import { expectDefined } from "@helios-lang/type-utils"
 import { configureCast } from "../cast/Cast.js"
 import { loadCompilerLib } from "../compiler/index.js"
 import { DagCompiler } from "./DagCompiler.js"
 import { contractContextCache } from "./ContractContextCache.js"
 
 /**
- * @typedef {import("@helios-lang/uplc").UplcData} UplcData
- * @typedef {import("../cast/index.js").CastConfig} CastConfig
- * @typedef {import("../codegen/LoadedModule.js").LoadedModule} LoadedModule
- * @typedef {import("../codegen/LoadedValidator.js").LoadedValidator} LoadedValidator
- * @typedef {import("../compiler/index.js").CompilerLib} CompilerLib
+ * @import { UplcData } from "@helios-lang/uplc"
+ * @import { CastConfig, CompilerLib, ContractContext, ContractContextBuilder, ContractContextBuilderProps, ExtractDependencies, LoadedModule, LoadedValidator } from "../index.js"
  */
 
 /**
- * @template {LoadedValidator} V
- * @typedef {import("../codegen/LoadedValidator.js").ExtractDependencies<V>} ExtractDependencies
- */
-
-/**
- * @template {{[name: string]: LoadedValidator}} Vs
- * @template {{[name: string]: LoadedModule}} Ms
- * @typedef {import("./ContractContext.js").ContractContext<Vs, Ms>} ContractContext
- */
-
-/**
- * if `debug` is true, the ir is included where possible
- * @typedef {{
- *   isMainnet: boolean
- *   expectedHashes?: {[name: string]: string}
- *   parameters?: Record<string, UplcData>
- *   dumpHashes?: boolean
- *   debug?: boolean
- * }} ContractContextBuildProps
+ * @returns {ContractContextBuilder<{}, {}>}
  */
+export function makeContractContextBuilder() {
+    return new ContractContextBuilderImpl({}, {})
+}
 
 /**
  * @template {{[name: string]: LoadedValidator}} Vs
  * @template {{[name: string]: LoadedModule}} Ms
+ * @implements {ContractContextBuilder<Vs, Ms>}
  */
-export class ContractContextBuilder {
+class ContractContextBuilderImpl {
     /**
      * @private
      * @readonly
@@ -54,7 +37,6 @@ export class ContractContextBuilder {
     modules
 
     /**
-     * @private
      * @param {Vs} validators
      * @param {Ms} modules
      */
@@ -63,13 +45,6 @@ export class ContractContextBuilder {
         this.modules = modules
     }
 
-    /**
-     * @returns {ContractContextBuilder<{}, {}>}
-     */
-    static new() {
-        return new ContractContextBuilder({}, {})
-    }
-
     /**
      * @template {LoadedValidator} V
      * @param {V} validator
@@ -79,17 +54,19 @@ export class ContractContextBuilder {
      * >}
      */
     with(validator) {
-        return new ContractContextBuilder(
-            /** @type {any} */ ({
-                ...this.validators,
-                [validator.$name]: validator
-            }),
-            /** @type {any} */ ({
-                ...this.modules,
-                ...Object.fromEntries(
-                    validator.$dependencies.map((d) => [d.$name, d])
-                )
-            })
+        return /** @type {any} */ (
+            new ContractContextBuilderImpl(
+                /** @type {any} */ ({
+                    ...this.validators,
+                    [validator.$name]: validator
+                }),
+                /** @type {any} */ ({
+                    ...this.modules,
+                    ...Object.fromEntries(
+                        validator.$dependencies.map((d) => [d.$name, d])
+                    )
+                })
+            )
         )
     }
 
@@ -102,17 +79,19 @@ export class ContractContextBuilder {
      * >}
      */
     withModule(m) {
-        return new ContractContextBuilder(
-            this.validators,
-            /** @type {any} */ ({
-                ...this.modules,
-                [m.$name]: m
-            })
+        return /** @type {any} */ (
+            new ContractContextBuilderImpl(
+                this.validators,
+                /** @type {any} */ ({
+                    ...this.modules,
+                    [m.$name]: m
+                })
+            )
         )
     }
 
     /**
-     * @param {ContractContextBuildProps} props
+     * @param {ContractContextBuilderProps} props
      * @returns {ContractContext<Vs, Ms>}
      */
     build(props) {
@@ -173,7 +152,7 @@ export class ContractContextBuilder {
                         ([funcKey, userFunc]) => [
                             funcKey,
                             userFunc(
-                                expectSome(
+                                expectDefined(
                                     compiled.userFuncs[`${name}::${funcKey}`]
                                 ),
                                 castConfig
@@ -203,9 +182,10 @@ export class ContractContextBuilder {
                                 return [
                                     funcKey,
                                     userFunc(
-                                        expectSome(
-                                            compiled.validators[name].context
-                                                .program
+                                        expectDefined(
+                                            /** @type {any} */ (
+                                                compiled.validators[name]
+                                            ).context.program
                                         ),
                                         castConfig
                                     )
@@ -214,7 +194,7 @@ export class ContractContextBuilder {
                                 return [
                                     funcKey,
                                     userFunc(
-                                        expectSome(
+                                        expectDefined(
                                             compiled.userFuncs[
                                                 `${name}::${funcKey}`
                                             ]

package/src/context/ContractContextCache.js

@@ -1,13 +1,11 @@
 import { bytesToHex, encodeUtf8 } from "@helios-lang/codec-utils"
 import { blake2b } from "@helios-lang/crypto"
-import { JSON, None } from "@helios-lang/type-utils"
+import { JSON } from "@helios-lang/type-utils"
 import { cacheEntryFromJson, cacheEntryToJsonSafe } from "./CacheEntry.js"
 
 /**
- * @typedef {import("@helios-lang/uplc").UplcData} UplcData
- * @typedef {import("@helios-lang/uplc").UplcProgram} UplcProgram
- * @typedef {import("../codegen/LoadedModule.js").LoadedModule} LoadedModule
- * @typedef {import("../codegen/LoadedValidator.js").LoadedValidator} LoadedValidator
+ * @import { UplcData, UplcProgram } from "@helios-lang/uplc"
+ * @import { LoadedModule, LoadedValidator } from "../index.js"
  * @typedef {import("./CacheEntry.js").CacheEntry} CacheEntry
  * @typedef {import("./CacheEntry.js").CacheEntryJson} CacheEntryJson
  * @typedef {import("./CacheEntry.js").CacheEntryUserFuncsJson} CacheEntryUserFuncsJson
@@ -129,11 +127,11 @@ class ContractContextCache {
                 )
             }
 
-            return None
+            return undefined
         } else {
             if (this.i >= this.positionalCache.length) {
                 // TODO: lookup in explicitCache
-                return None
+                return undefined
             }
 
             const res = this.positionalCache[this.i]