@helios-lang/contract-utils 0.1.20 → 0.1.24

package/src/codegen/LoadedValidator.js

@@ -0,0 +1,23 @@
+import { Cast } from "../cast/Cast.js"
+
+/**
+ * @typedef {import("./LoadedModule.js").LoadedModule} LoadedModule
+ */
+
+/**
+ * @typedef {{
+ *   $name: string
+ *   $sourceCode: string
+ *   $dependencies: LoadedModule[]
+ *   $hashDependencies: LoadedValidator[]
+ *   $dependsOnOwnHash: boolean
+ *   $Redeemer: Cast
+ * } & (
+ *   {
+ *     $purpose: "spending"
+ *     $Datum: Cast
+ *   } | {
+ *     $purpose: "minting" | "certifying" | "rewarding" | "staking"
+ *   }
+ * )} LoadedValidator
+ */

package/src/codegen/{Module.js → TypeCheckedModule.js}

@@ -1,3 +1,5 @@
+export {}
+
 /**
  * @typedef {import("./TypeSchema.js").TypeSchema} TypeSchema
  */
@@ -9,7 +11,5 @@
  *   sourceCode: string
  *   moduleDepedencies: string[]
  *   types: {[name: string]: TypeSchema}
- * }} Module
+ * }} TypeCheckedModule
  */
-
-export const _ = {}

package/src/codegen/{Validator.js → TypeCheckedValidator.js}

@@ -1,17 +1,14 @@
-/**
- * @typedef {import("./TypeSchema.js").TypeSchema} TypeSchema
- */
+export {}
 
 /**
- * @typedef {import("./Module.js").Module} Module
+ * @typedef {import("./TypeCheckedModule.js").TypeCheckedModule} TypeCheckedModule
+ * @typedef {import("./TypeSchema.js").TypeSchema} TypeSchema
  */
 
 /**
- * @typedef {Module & {
+ * @typedef {TypeCheckedModule & {
  *   hashDependencies: string[]
  *   Redeemer: TypeSchema
  *   Datum?: TypeSchema
- * }} Validator
+ * }} TypeCheckedValidator
  */
-
-export const _ = {}

package/src/codegen/TypeSchema.js

@@ -1,4 +1,8 @@
 /**
+ * TODO: references and ids for recursive types and more descriptive codegen
+ * TODO: use `kind: "internal" | "list" | "map" | "struct" | "option" | "enum"` instead of `primitiveType` etc.
+ * TODO: additional property for struct: `format: "list" | "map"`
+ * TODO: rename primitiveType -> internalType
  * @typedef {{
  *     primitiveType: string
  * } | {
@@ -58,11 +62,11 @@ export function genTypes(schema) {
                     "MintingPolicyHash | string | number[]"
                 ]
             case "PubKey":
-                return ["string", "string | number[]"]
+                return ["PubKey", "PubKey | string | number[]"]
             case "PubKeyHash":
                 return ["PubKeyHash", "PubKeyHash | string | number[]"]
             case "Real":
-                return ["number", "numer"]
+                return ["number", "number"]
             case "StakingCredential":
                 return [
                     "StakingCredential",

package/src/codegen/index.js

@@ -1,8 +1,9 @@
-export { TypescriptWriter } from "./TypescriptWriter.js"
-export { Writer } from "./Writer.js"
+export { LoadedScriptsWriter } from "./LoadedScriptsWriter.js"
 
 /**
- * @typedef {import("./Module.js").Module} Module
+ * @typedef {import("./LoadedModule.js").LoadedModule} LoadedModule
+ * @typedef {import("./LoadedValidator.js").LoadedValidator} LoadedValidator
+ * @typedef {import("./TypeCheckedModule.js").TypeCheckedModule} TypeCheckedModule
+ * @typedef {import("./TypeCheckedValidator.js").TypeCheckedValidator} TypeCheckedValidator
  * @typedef {import("./TypeSchema.js").TypeSchema} TypeSchema
- * @typedef {import("./Validator.js").Validator} Validator
  */

package/src/compiler/CompilerLib.js

@@ -0,0 +1,51 @@
+export {}
+
+/**
+ * @typedef {import("../codegen/index.js").TypeSchema} InternalTypeDetails
+ * @typedef {import("../codegen/index.js").TypeCheckedModule} TypeCheckedModule
+ * @typedef {import("../codegen/index.js").TypeCheckedValidator} TypeCheckedValidator
+ */
+
+/**
+ * @typedef {{
+ *   allValidatorHashTypes: {[name: string]: any},
+ *   hashDependencies: {[name: string]: string},
+ *   dependsOnOwnHash?: boolean,
+ *   ownHash?: string,
+ *   optimize: boolean
+ * }} CompileOptions
+ */
+
+/**
+ * @typedef {{
+ *   cborHex: string
+ *   prettyIR: string
+ * }} CompileOutput
+ */
+
+/**
+ * @typedef {{
+ *   modules: {[name: string]: TypeCheckedModule}
+ *   validators: {[name: string]: TypeCheckedValidator}
+ * }} TypeCheckOutput
+ */
+
+/**
+ * @typedef {{
+ *   name: string
+ *   purpose: string
+ *   sourceCode: string
+ * }} SourceDetails
+ */
+
+/**
+ * @typedef {{
+ *   version: string
+ *   getScriptHashType: (purpose: string) => any
+ *   typeCheck: (validators: string[], modules: string[]) => ({
+ *     modules: {[name: string]: TypeCheckedModule},
+ *     validators: {[name: string]: TypeCheckedValidator}
+ *   })
+ *   compile: (main: string, modules: string[], options: CompileOptions) => CompileOutput
+ * }} CompilerLib
+ */