@helios-lang/contract-utils 0.1.19 → 0.1.23

package/types/runtime/ContractContextBuilder.d.ts

@@ -1,57 +1,17 @@
 /**
+ * @typedef {import("../codegen/LoadedModule.js").LoadedModule} LoadedModule
+ * @typedef {import("../codegen/LoadedValidator.js").LoadedValidator} LoadedValidator
  * @typedef {import("../lib/index.js").Lib} Lib
- * @typedef {import("../lib/index.js").LibOptions} LibOptions
- * @typedef {import("./ContractContext.js").Validator} CompiledValidator
  */
 /**
- * @template TRedeemerStrict
- * @template TRedeemerPermissive
- * @typedef {import("@helios-lang/ledger").MintingContext<TRedeemerStrict, TRedeemerPermissive>} MintingContext
+ * @template {{[name: string]: LoadedValidator}} T
+ * @typedef {import("./ContractContext.js").ContractContext<T>} ContractContext
  */
 /**
- * @template TDatumStrict
- * @template TDatumPermissive
- * @template TRedeemerStrict
- * @template TRedeemerPermissive
- * @typedef {import("@helios-lang/ledger").SpendingContext<TDatumStrict, TDatumPermissive, TRedeemerStrict, TRedeemerPermissive>} SpendingContext
- */
-/**
- * @template TRedeemerStrict
- * @template TRedeemerPermissive
- * @typedef {import("@helios-lang/ledger").StakingContext<TRedeemerStrict, TRedeemerPermissive>} StakingContext
- */
-/**
- * @template {Cast} C
- * @typedef {import("./PermissiveType.js").PermissiveType<C>} PermissiveType
- */
-/**
- * @template {Cast} C
- * @typedef {import("./StrictType.js").StrictType<C>} StrictType
- */
-/**
- * @typedef {{
- *   $name: string
- *   $sourceCode: string
- *   $dependencies: Module[]
- * }} Module
- */
-/**
- * @typedef {{
- *   $name: string
- *   $purpose: string
- *   $sourceCode: string
- *   $dependencies: Module[]
- *   $hashDependencies: Validator[]
- *   $dependsOnOwnHash: boolean
- *   $Redeemer: Cast<any, any>
- *   $Datum?: Cast<any, any>
- * }} Validator
- */
-/**
- * @template {{[name: string]: Validator}} T
+ * @template {{[name: string]: LoadedValidator}} T
  */
 export class ContractContextBuilder<T extends {
-    [name: string]: Validator;
+    [name: string]: import("./DagCompiler.js").LoadedValidator;
 }> {
     /**
      * @returns {ContractContextBuilder<{}>}
@@ -60,7 +20,6 @@ export class ContractContextBuilder<T extends {
     /**
      * @private
      * @param {T} validators
-     * @param {Option<Module[]>} forcedModules
      */
     private constructor();
     /**
@@ -70,92 +29,25 @@ export class ContractContextBuilder<T extends {
      */
     private readonly validators;
     /**
-     * @private
-     * @readonly
-     * @type {Option<Module[]>}
-     */
-    private readonly forcedModules;
-    /**
-     * @param {Module[]} modules
-     * @returns {ContractContextBuilder<T>}
-     */
-    setModules(modules: Module[]): ContractContextBuilder<T>;
-    /**
-     * @template {Validator} V
+     * @template {LoadedValidator} V
      * @param {V} validator
      * @returns {ContractContextBuilder<T & {
      *   [K in V["$name"]]: V
      * }>}
      */
-    with<V extends Validator>(validator: V): ContractContextBuilder<T & { [K in V["$name"]]: V; }>;
-    /**
-     * @private
-     * @param {Validator} validator
-     * @returns {Map<string, string>}
-     */
-    private getModules;
-    /**
-     * @private
-     * @param {Lib} lib
-     * @returns {{[name: string]: any}}
-     */
-    private getValidatorTypes;
+    with<V extends import("./DagCompiler.js").LoadedValidator>(validator: V): ContractContextBuilder<T & { [K in V["$name"]]: V; }>;
     /**
      * @param {Option<{[name: string]: string}>} expectedHashes
-     * @param {LibOptions} options
-     * @returns {{
-     *   [K in keyof T]:
-     *     T[K]["$purpose"] extends "spending" ? ValidatorHash<
-     *       SpendingContext<
-     *         StrictType<T[K]["$Datum"]>,
-     *         PermissiveType<T[K]["$Datum"]>,
-     *         StrictType<T[K]["$Redeemer"]>,
-     *         PermissiveType<T[K]["$Redeemer"]>
-     *       >
-     *     > :
-     *     T[K]["$purpose"] extends "minting" ? MintingPolicyHash<
-     *       MintingContext<
-     *         StrictType<T[K]["$Redeemer"]>,
-     *         PermissiveType<T[K]["$Redeemer"]>
-     *       >
-     *     > :
-     *     T[K]["$purpose"] extends ("certifying" | "rewarding") ? StakingValidatorHash<
-     *       StakingContext<
-     *         StrictType<T[K]["$Redeemer"]>,
-     *         PermissiveType<T[K]["$Redeemer"]>
-     *       >
-     *     > : never
-     * }}
+     * @returns {ContractContext<T>}
      */
     build(expectedHashes?: Option<{
         [name: string]: string;
-    }>, options?: LibOptions): { [K_1 in keyof T]: T[K_1]["$purpose"] extends "spending" ? ValidatorHash<SpendingContext<import("./StrictType.js").StrictType<T[K_1]["$Datum"]>, import("./PermissiveType.js").PermissiveType<T[K_1]["$Datum"]>, import("./StrictType.js").StrictType<T[K_1]["$Redeemer"]>, import("./PermissiveType.js").PermissiveType<T[K_1]["$Redeemer"]>>> : T[K_1]["$purpose"] extends "minting" ? MintingPolicyHash<MintingContext<import("./StrictType.js").StrictType<T[K_1]["$Redeemer"]>, import("./PermissiveType.js").PermissiveType<T[K_1]["$Redeemer"]>>> : T[K_1]["$purpose"] extends "certifying" | "rewarding" ? StakingValidatorHash<StakingContext<import("./StrictType.js").StrictType<T[K_1]["$Redeemer"]>, import("./PermissiveType.js").PermissiveType<T[K_1]["$Redeemer"]>>> : never; };
+    }>): ContractContext<T>;
 }
+export type LoadedModule = import("../codegen/LoadedModule.js").LoadedModule;
+export type LoadedValidator = import("../codegen/LoadedValidator.js").LoadedValidator;
 export type Lib = import("../lib/index.js").Lib;
-export type LibOptions = import("../lib/index.js").LibOptions;
-export type CompiledValidator = import("./ContractContext.js").Validator;
-export type MintingContext<TRedeemerStrict, TRedeemerPermissive> = import("@helios-lang/ledger").MintingContext<TRedeemerStrict, TRedeemerPermissive>;
-export type SpendingContext<TDatumStrict, TDatumPermissive, TRedeemerStrict, TRedeemerPermissive> = import("@helios-lang/ledger").SpendingContext<TDatumStrict, TDatumPermissive, TRedeemerStrict, TRedeemerPermissive>;
-export type StakingContext<TRedeemerStrict, TRedeemerPermissive> = import("@helios-lang/ledger").StakingContext<TRedeemerStrict, TRedeemerPermissive>;
-export type PermissiveType<C extends Cast<import("@helios-lang/ledger").UplcData, import("@helios-lang/ledger").UplcData>> = import("./PermissiveType.js").PermissiveType<C>;
-export type StrictType<C extends Cast<import("@helios-lang/ledger").UplcData, import("@helios-lang/ledger").UplcData>> = import("./StrictType.js").StrictType<C>;
-export type Module = {
-    $name: string;
-    $sourceCode: string;
-    $dependencies: Module[];
-};
-export type Validator = {
-    $name: string;
-    $purpose: string;
-    $sourceCode: string;
-    $dependencies: Module[];
-    $hashDependencies: Validator[];
-    $dependsOnOwnHash: boolean;
-    $Redeemer: Cast<any, any>;
-    $Datum?: Cast<any, any>;
-};
-import { ValidatorHash } from "@helios-lang/ledger";
-import { MintingPolicyHash } from "@helios-lang/ledger";
-import { StakingValidatorHash } from "@helios-lang/ledger";
-import { Cast } from "./Cast.js";
+export type ContractContext<T extends {
+    [name: string]: import("./DagCompiler.js").LoadedValidator;
+}> = import("./ContractContext.js").ContractContext<T>;
 //# sourceMappingURL=ContractContextBuilder.d.ts.map

package/types/runtime/ContractContextBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContractContextBuilder.d.ts","sourceRoot":"","sources":["../../src/runtime/ContractContextBuilder.js"],"names":[],"mappings":"AAaA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;GAWG;AAEH;;GAEG;AACH;;;IAyBI;;OAEG;IACH,gBAFa,uBAAuB,EAAE,CAAC,CAItC;IAfD;;;;OAIG;IACH,sBAGC;IAtBD;;;;OAIG;IACH,4BAAU;IAEV;;;;OAIG;IACH,+BAAa;IAmBb;;;OAGG;IACH,oBAHW,MAAM,EAAE,GACN,uBAAuB,CAAC,CAAC,CAIrC;IAED;;;;;;OAMG;IACH,+FAQC;IAED;;;;OAIG;IACH,mBAyBC;IAED;;;;OAIG;IACH,0BAMC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH;;kBAzBW,UAAU,qwBAiKpB;CACJ;kBArUY,OAAO,iBAAiB,EAAE,GAAG;yBAC7B,OAAO,iBAAiB,EAAE,UAAU;gCACpC,OAAO,sBAAsB,EAAE,SAAS;mEAMxC,OAAO,qBAAqB,EAAE,cAAc,CAAC,eAAe,EAAE,mBAAmB,CAAC;oGAQlF,OAAO,qBAAqB,EAAE,eAAe,CAAC,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,mBAAmB,CAAC;mEAMnH,OAAO,qBAAqB,EAAE,cAAc,CAAC,eAAe,EAAE,mBAAmB,CAAC;6HAKlF,OAAO,qBAAqB,EAAE,cAAc,CAAC,CAAC,CAAC;yHAK/C,OAAO,iBAAiB,EAAE,UAAU,CAAC,CAAC,CAAC;qBAIvC;IACZ,KAAS,EAAE,MAAM,CAAA;IACjB,WAAe,EAAE,MAAM,CAAA;IACvB,aAAiB,EAAE,MAAM,EAAE,CAAA;CACxB;wBAIS;IACZ,KAAS,EAAE,MAAM,CAAA;IACjB,QAAY,EAAE,MAAM,CAAA;IACpB,WAAe,EAAE,MAAM,CAAA;IACvB,aAAiB,EAAE,MAAM,EAAE,CAAA;IAC3B,iBAAqB,EAAE,SAAS,EAAE,CAAA;IAClC,iBAAqB,EAAE,OAAO,CAAA;IAC9B,SAAa,EAAE,KAAK,GAAG,EAAE,GAAG,CAAC,CAAA;IAC7B,MAAU,CAAC,EAAE,KAAK,GAAG,EAAE,GAAG,CAAC,CAAA;CACxB;8BA7DG,qBAAqB;kCAArB,qBAAqB;qCAArB,qBAAqB;qBAIP,WAAW"}
+{"version":3,"file":"ContractContextBuilder.d.ts","sourceRoot":"","sources":["../../src/runtime/ContractContextBuilder.js"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH;;;GAGG;AAEH;;GAEG;AACH;;;IAgBI;;OAEG;IACH,gBAFa,uBAAuB,EAAE,CAAC,CAItC;IAbD;;;OAGG;IACH,sBAEC;IAbD;;;;OAIG;IACH,4BAAU;IAiBV;;;;;;OAMG;IACH,gIAKC;IAED;;;OAGG;IACH;;SAFa,gBAAgB,CAAC,CAAC,CAU9B;CACJ;2BA/DY,OAAO,4BAA4B,EAAE,YAAY;8BACjD,OAAO,+BAA+B,EAAE,eAAe;kBACvD,OAAO,iBAAiB,EAAE,GAAG;;;KAK7B,OAAO,sBAAsB,EAAE,eAAe,CAAC,CAAC,CAAC"}

package/types/runtime/DagCompiler.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @param {LoadedValidator} validator
+ * @returns {string[]}
+ */
+export function getModuleDependencies(validator: LoadedValidator): string[];
+/**
+ * @typedef {import("../codegen/LoadedValidator.js").LoadedValidator} LoadedValidator
+ * @typedef {import("../lib/index.js").Lib} Lib
+ * @typedef {import("./ContractContext.js").AnyContractValidatorHash} AnyContractValidatorHash
+ */
+/**
+ * Compiles a set of validators that depend on eachothers hashes (forming a Directed Acyclical Graph)
+ */
+export class DagCompiler {
+    /**
+     * @param {Lib} lib
+     */
+    constructor(lib: Lib);
+    /**
+     * @private
+     * @readonly
+     * @type {Lib}
+     */
+    private readonly lib;
+    /**
+     * @private
+     * @readonly
+     * @type {{[name: string]: AnyContractValidatorHash}}
+     */
+    private readonly cache;
+    /**
+     * @param {LoadedValidator[]} validators
+     * @param {Option<{[name: string]: string}>} expectedHashes
+     * @returns {{[name: string]: AnyContractValidatorHash}}
+     */
+    build(validators: LoadedValidator[], expectedHashes?: Option<{
+        [name: string]: string;
+    }>): {
+        [name: string]: import("./ContractContext.js").AnyContractValidatorHash;
+    };
+    /**
+     * @private
+     * @param {LoadedValidator} validator
+     * @param {UplcProgramV2} program
+     * @param {string} hash - although this can be derived from `program`, reuse this to save some effort
+     */
+    private addToCache;
+    /**
+     * @private
+     * @param {LoadedValidator} validator
+     * @returns {{[name: string]: string}} - TODO: do we really need the purpose?
+     */
+    private getHashDependencies;
+    /**
+     * @private
+     * @param {LoadedValidator[]} validators
+     * @returns {{[name: string]: any}}
+     */
+    private getHashTypes;
+}
+export type LoadedValidator = import("../codegen/LoadedValidator.js").LoadedValidator;
+export type Lib = import("../lib/index.js").Lib;
+export type AnyContractValidatorHash = import("./ContractContext.js").AnyContractValidatorHash;
+//# sourceMappingURL=DagCompiler.d.ts.map

package/types/runtime/DagCompiler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DagCompiler.d.ts","sourceRoot":"","sources":["../../src/runtime/DagCompiler.js"],"names":[],"mappings":"AA4MA;;;GAGG;AACH,iDAHW,eAAe,GACb,MAAM,EAAE,CAsBpB;AA3ND;;;;GAIG;AAEH;;GAEG;AACH;IAeI;;OAEG;IACH,iBAFW,GAAG,EAKb;IApBD;;;;OAIG;IACH,qBAAG;IAEH;;;;OAIG;IACH,uBAAK;IAUL;;;;OAIG;IACH,kBAJW,eAAe,EAAE;;;;MAkF3B;IAED;;;;;OAKG;IACH,mBA6BC;IAED;;;;OAIG;IACH,4BAoBC;IAED;;;;OAIG;IACH,qBAMC;CACJ;8BAhMY,OAAO,+BAA+B,EAAE,eAAe;kBACvD,OAAO,iBAAiB,EAAE,GAAG;uCAC7B,OAAO,sBAAsB,EAAE,wBAAwB"}

package/types/runtime/PermissiveType.d.ts

@@ -1,3 +1,3 @@
 export type PermissiveType<C extends Cast<import("@helios-lang/uplc/types/data/UplcData.js").UplcData, import("@helios-lang/uplc/types/data/UplcData.js").UplcData>> = C extends Cast<any, infer TPermissive> ? TPermissive : never;
-import { Cast } from "./Cast.js";
+import { Cast } from "../cast/Cast.js";
 //# sourceMappingURL=PermissiveType.d.ts.map

package/types/runtime/StrictType.d.ts

@@ -1,3 +1,3 @@
 export type StrictType<C extends Cast<import("@helios-lang/uplc/types/data/UplcData.js").UplcData, import("@helios-lang/uplc/types/data/UplcData.js").UplcData>> = C extends Cast<infer TStrict, any> ? TStrict : never;
-import { Cast } from "./Cast.js";
+import { Cast } from "../cast/Cast.js";
 //# sourceMappingURL=StrictType.d.ts.map

package/types/runtime/index.d.ts

@@ -1,4 +1,2 @@
-export { Cast } from "./Cast.js";
-export { ContractContext } from "./ContractContext.js";
 export { ContractContextBuilder } from "./ContractContextBuilder.js";
 //# sourceMappingURL=index.d.ts.map

package/src/codegen/Writer.js

@@ -1,37 +0,0 @@
-export class Writer {
-    /**
-     * @private
-     * @readonly
-     * @type {string[]}
-     */
-    parts
-
-    constructor() {
-        this.parts = []
-    }
-
-    /**
-     * @param {string} part
-     * @returns {Writer}
-     */
-    write(part) {
-        this.parts.push(part)
-        return this
-    }
-
-    /**
-     * @param {string} line
-     * @returns {Writer}
-     */
-    writeLine(line) {
-        this.parts.push(`${line}\n`)
-        return this
-    }
-
-    /**
-     * @returns {string}
-     */
-    finalize() {
-        return this.parts.join("")
-    }
-}

package/src/lib/Lib.js

@@ -1,56 +0,0 @@
-/**
- * @typedef {{
- *   allValidatorTypes: {[name: string]: any},
- *   otherValidators: {[name: string]: {purpose: string, hash: string}},
- *   dependsOnOwnHash?: boolean,
- *   ownHash?: string,
- *   optimize: boolean
- * }} CompileOptions
- */
-
-/**
- * @typedef {{
- *   cborHex: string
- *   prettyIR: string
- * }} CompileOutput
- */
-
-/**
- * @typedef {{
- *   isMainnet?: boolean
- *   checkCasts?: boolean
- *   moduleOrder?: string[]
- * }} LibOptions
- */
-
-/**
- * @typedef {{
- *   version: string
- *   getValidatorType: (purpose: string) => any
- *   typeCheck: (validators: {[name: string]: SourceDetails}, modules: {[name: string]: SourceDetails}) => ({
- * modules: {[name: string]: ModuleDetails}, validators: {[name: string]: ValidatorDetails}})
- *   compile: (main: string, modules: string[], options: CompileOptions) => CompileOutput
- * }} Lib
- */
-
-/**
- * @typedef {import("../codegen/index.js").TypeSchema} InternalTypeDetails
- * @typedef {import("../codegen/index.js").Module} ModuleDetails
- * @typedef {import("../codegen/index.js").Validator} ValidatorDetails
- */
-
-/**
- * @typedef {{
- *   name: string
- *   purpose: string
- *   sourceCode: string
- * }} SourceDetails
- */
-
-/**
- * @param {{VERSION: string}} lib
- * @returns {number[]}
- */
-export function getVersion(lib) {
-    return lib.VERSION.split(".").map((v) => Number(v))
-}

package/src/lib/index.js

@@ -1,6 +0,0 @@
-export { loadLibrary } from "./load.js"
-
-/**
- * @typedef {import("./Lib.js").Lib} Lib
- * @typedef {import("./Lib.js").LibOptions} LibOptions
- */

package/src/lib/load.js

@@ -1,26 +0,0 @@
-import * as lib from "@helios-lang/compiler"
-import { getVersion } from "./Lib.js"
-import { Lib_v0_16 } from "./Libg_v0_16.js"
-
-/**
- * @typedef {import("./Lib.js").Lib} Lib
- * @typedef {import("./Lib.js").LibOptions} LibOptions
- */
-
-/**
- * @param {LibOptions} options
- * @returns {Lib}
- */
-export function loadLibrary(options = {}) {
-    const [major, minor] = getVersion(lib)
-
-    switch (major) {
-        case 0:
-            switch (minor) {
-                case 16:
-                    return new Lib_v0_16(lib, options)
-            }
-        default:
-            throw new Error(`compiler version ${lib.VERSION} not supported`)
-    }
-}

package/src/runtime/ContractContext.js

@@ -1,35 +0,0 @@
-import { ScriptHash } from "@helios-lang/ledger"
-import { UplcProgramV2 } from "@helios-lang/uplc"
-import { Cast } from "./Cast.js"
-
-/**
- * @typedef {{
- *   $name: string
- *   $purpose: string
- *   $program: {
- *     optimized: UplcProgramV2
- *     unoptimized: UplcProgramV2
- *   }
- *   $hash: ScriptHash
- *   $Redeemer: Cast<any, any>
- *   $Datum?: Cast<any, any>
- * }} Validator
- */
-
-/**
- * @template {{[name: string]: Validator}} T
- */
-export class ContractContext {
-    /**
-     * @readonly
-     * @type {T}
-     */
-    validators
-
-    /**
-     * @param {T} validators
-     */
-    constructor(validators) {
-        this.validators = validators
-    }
-}