@helios-lang/contract-utils 0.1.6 → 0.1.8

package/examples/spending/contract.js

@@ -0,0 +1,16 @@
+import { ContractContextBuilder } from "@helios-lang/contract-utils"
+import { Address, TxBuilder } from "@helios-lang/ledger"
+import { match_string, match_string_policy } from "./index.js"
+
+const context = ContractContextBuilder.new()
+    .with(match_string)
+    .with(match_string_policy)
+    .build()
+
+console.log(context.match_string_policy.toHex())
+
+const address = Address.fromHash(context.match_string)
+
+const b = new TxBuilder()
+    .mint(context.match_string_policy, [["", 10]], "hello")
+    .pay(address, 0n, { hash: { One: { message: "hello" } } })

package/examples/spending/index.d.ts

@@ -0,0 +1,29 @@
+import type {UplcData} from "@helios-lang/ledger";
+import { Address, AssetClass, Credential, DatumHash, MintingPolicyHash, PubKeyHash, StakingCredential, StakingHash, StakingValidatorHash, TimeRange, TxId, TxOutputDatum, ValidatorHash, Value} from "@helios-lang/ledger";
+import { Cast } from "@helios-lang/contract-utils";
+export const utils: {
+    $name: string
+    $purpose: string
+    $sourceCode: string
+    $dependencies: []
+}
+export const match_string_policy: {
+    $name: "match_string_policy"
+    $purpose: "minting"
+    $sourceCode: string
+    $dependencies: []
+    $hashDependencies: []
+    $dependsOnOwnHash: boolean
+    $Redeemer: Cast<string, string>
+    
+}
+export const match_string: {
+    $name: "match_string"
+    $purpose: "spending"
+    $sourceCode: string
+    $dependencies: [typeof utils]
+    $hashDependencies: []
+    $dependsOnOwnHash: boolean
+    $Redeemer: Cast<string, string>
+    $Datum: Cast<{One: {message: string}} | {Two: {code: bigint}}, {One: {message: string}} | {Two: {code: bigint | number | string}}>
+}

package/examples/spending/index.js

@@ -0,0 +1,27 @@
+import { Cast } from "@helios-lang/contract-utils";
+export const utils = {
+    $name: "utils",
+    $purpose: "module",
+    $sourceCode: "module utils\n\nfunc compare(a: String, b: String) -> Bool {\n    a == b\n}",
+    $dependencies: [],
+}
+export const match_string_policy = {
+    $name: "match_string_policy",
+    $purpose: "minting",
+    $sourceCode: "minting match_string_policy\n\nfunc main(redeemer: String, _) -> Bool {\n    redeemer == \"Hello\"\n}",
+    $dependencies: [],
+    $hashDependencies: [],
+    $dependsOnOwnHash: false,
+    $Redeemer: new Cast({"primitiveType":"String"}),
+    
+}
+export const match_string = {
+    $name: "match_string",
+    $purpose: "spending",
+    $sourceCode: "spending match_string\n\nimport { compare } from utils\n\nenum Datum {\n One {\n  message: String\n }\n\n Two {\n  code: Int\n }\n}\n\nfunc main(datum: Datum, redeemer: String, _) -> Bool {\n compare(datum.switch{d: One => d.message, d: Two => d.code.show()}, redeemer)\n}",
+    $dependencies: [utils],
+    $hashDependencies: [],
+    $dependsOnOwnHash: false,
+    $Redeemer: new Cast({"primitiveType":"String"}),
+    $Datum: new Cast({"enumVariantTypes":[{"name":"One","fieldTypes":[{"name":"message","type":{"primitiveType":"String"}}]},{"name":"Two","fieldTypes":[{"name":"code","type":{"primitiveType":"Int"}}]}]})
+}

package/examples/spending/minting.hl

@@ -0,0 +1,5 @@
+minting match_string_policy
+
+func main(redeemer: String, _) -> Bool {
+    redeemer == "Hello"
+}

package/examples/spending/package-lock.json

@@ -6,16 +6,24 @@
     "": {
       "name": "spending_example",
       "dependencies": {
+        "@helios-lang/compiler": "0.16.7-1",
         "@helios-lang/contract-utils": "file:../..",
         "@hyperionbt/helios": "^0.16.7"
+      },
+      "devDependencies": {
+        "typescript": "^5.4.3"
       }
     },
     "../..": {
       "name": "@helios-lang/contract-utils",
-      "version": "0.1.1",
+      "version": "0.1.7",
       "license": "BSD-3-Clause",
       "dependencies": {
-        "@helios-lang/compiler-utils": "^0.1.2"
+        "@helios-lang/codec-utils": "^0.1.26",
+        "@helios-lang/compiler-utils": "^0.1.20",
+        "@helios-lang/ledger": "^0.1.10",
+        "@helios-lang/type-utils": "^0.1.8",
+        "@helios-lang/uplc": "^0.1.21"
       },
       "bin": {
         "hl2ts": "src/hl2ts.js"
@@ -24,6 +32,17 @@
         "@types/node": "^20.11.24",
         "prettier": "^3.1.0",
         "typescript": "^5.3.2"
+      },
+      "peerDependencies": {
+        "@helios-lang/compiler": "^0.16.7"
+      }
+    },
+    "node_modules/@helios-lang/compiler": {
+      "version": "0.16.7-1",
+      "resolved": "https://registry.npmjs.org/@helios-lang/compiler/-/compiler-0.16.7-1.tgz",
+      "integrity": "sha512-M6x99ApFUNtNrPucx5IrcTbqHP1yyVQXeaKuQWOICgioSbWMKeogN7Hn2INk6f//DzGaqFZ7Cd1JOtt8zXHE/Q==",
+      "dependencies": {
+        "@hyperionbt/helios": "0.16.7"
       }
     },
     "node_modules/@helios-lang/contract-utils": {
@@ -34,6 +53,19 @@
       "version": "0.16.7",
       "resolved": "https://registry.npmjs.org/@hyperionbt/helios/-/helios-0.16.7.tgz",
       "integrity": "sha512-ysPaF0OCY0NJa1mc+LXERjH71VDNGUbYrrovKUHJv1v+eS1WJhKmxSHWh9sVa6b+sYoXdKwoCR20UQhzCF5jzA=="
+    },
+    "node_modules/typescript": {
+      "version": "5.4.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.3.tgz",
+      "integrity": "sha512-KrPd3PKaCLr78MalgiwJnA25Nm8HAmdwN3mYUYZgG/wizIo9EainNVQI9/yDavtVFRN2h3k8uf3GLHuhDMgEHg==",
+      "dev": true,
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
     }
   }
 }

package/examples/spending/package.json

@@ -1,7 +1,12 @@
 {
   "name": "spending_example",
+  "type": "module",
   "dependencies": {
+    "@helios-lang/compiler": "0.16.7-1",
     "@helios-lang/contract-utils": "file:../..",
     "@hyperionbt/helios": "^0.16.7"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.3"
   }
 }

package/jsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "checkJs": true,
+        "declaration": true,
+        "declarationMap": true,
+        "declarationDir": "./types",
+        "skipLibCheck": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "moduleResolution": "nodenext",
+        "module": "nodenext",
+        "target": "esnext"
+    },
+    "exclude": ["node_modules", "**/*.d.ts"],
+    "include": ["src/**/*.js", "node_modules/@helios-lang/type-utils"]
+}

package/package.json

@@ -1,14 +1,16 @@
 {
     "name": "@helios-lang/contract-utils",
-    "version": "0.1.6",
+    "version": "0.1.8",
     "description": "Convenience and type-safety utilities for using Helios validators from within Typescript",
     "main": "src/index.js",
+    "types": "types/index.d.ts",
     "type": "module",
     "bin": {
         "hl2ts": "src/hl2ts.js"
     },
     "scripts": {
-        "build": "npx tsc",
+        "build": "npm run build:types",
+        "build:types": "npx tsc -p jsconfig.json --noEmit false --emitDeclarationOnly",
         "clean": "find src/ -name *.d.ts* | xargs rm",
         "prettify": "npx prettier . --write",
         "test": "npm run test:pretty && npm run test:types && npm run test:suite",
@@ -32,8 +34,11 @@
     "dependencies": {
         "@helios-lang/codec-utils": "^0.1.26",
         "@helios-lang/compiler-utils": "^0.1.20",
-        "@helios-lang/ledger": "^0.1.10",
+        "@helios-lang/ledger": "^0.1.20",
         "@helios-lang/type-utils": "^0.1.8",
-        "@helios-lang/uplc": "^0.1.21"
+        "@helios-lang/uplc": "^0.1.22"
+    },
+    "peerDependencies": {
+        "@helios-lang/compiler": "0.16.7-1"
     }
 }

package/src/codegen/TypescriptWriter.js

@@ -82,8 +82,8 @@ export class TypescriptWriter {
 }
 `,
             `export const ${v.name}: {
-    $name: string
-    $purpose: string
+    $name: "${v.name}"
+    $purpose: "${v.purpose}"
     $sourceCode: string
     $dependencies: [${v.moduleDepedencies.map((d) => `typeof ${d}`).join(", ")}]
     $hashDependencies: [${v.hashDependencies
@@ -99,11 +99,19 @@ export class TypescriptWriter {
     }
 
     writeHeaders() {
-        this.wjs.writeLine("import { Cast } from \"@helios-lang/contract-utils\";")
+        this.wjs.writeLine(
+            'import { Cast } from "@helios-lang/contract-utils";'
+        )
 
-        this.wdts.writeLine("import type {UplcData} from \"@helios-lang/ledger\";")
-        this.wdts.writeLine("import { Address, AssetClass, Credential, DatumHash, MintingPolicyHash, PubKeyHash, StakingCredential, StakingHash, StakingValidatorHash, TimeRange, TxId, TxOutputDatum, ValidatorHash, Value} from \"@helios-lang/ledger\";")
-        this.wdts.writeLine("import { Cast } from \"@helios-lang/contract-utils\";")
+        this.wdts.writeLine(
+            'import type {UplcData} from "@helios-lang/ledger";'
+        )
+        this.wdts.writeLine(
+            'import { Address, AssetClass, Credential, DatumHash, MintingPolicyHash, PubKeyHash, StakingCredential, StakingHash, StakingValidatorHash, TimeRange, TxId, TxOutputDatum, ValidatorHash, Value} from "@helios-lang/ledger";'
+        )
+        this.wdts.writeLine(
+            'import { Cast } from "@helios-lang/contract-utils";'
+        )
     }
 
     /**

package/src/hl2ts.js

@@ -26,8 +26,10 @@ async function main() {
 
     const w = new TypescriptWriter()
 
+    w.writeHeaders()
     w.writeModules(modules)
     w.writeValidators(validators)
+
     const [js, dts] = w.finalize()
 
     const jsPath = join(outDir, "index.js")

package/src/index.js

@@ -0,0 +1 @@
+export { Cast, ContractContextBuilder } from "./runtime/index.js"

package/src/lib/Lib.js

@@ -1,8 +1,23 @@
+/**
+ * @typedef {{
+ *   otherValidators: {[name: string]: {purpose: string, hash: string}},
+ *   dependsOnOwnHash?: boolean,
+ *   ownHash?: string,
+ *   optimize: boolean
+ * }} CompileOptions
+ */
+
+/**
+ * @typedef {{
+ *   cborHex: string
+ * }} CompileOutput
+ */
 /**
  * @typedef {{
  *   version: string
  *   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
  */
 

package/src/lib/Libg_v0_16.js

@@ -1,14 +1,17 @@
-/**
- * @typedef {import("./Lib.js").Lib} Lib
- * @typedef {import("./Lib.js").SourceDetails} SourceDetails
- */
-
 /**
  * @typedef {import("../codegen/index.js").Module} ModuleDetails
  * @typedef {import("../codegen/index.js").Validator} ValidatorDetails
  * @typedef {import("../codegen/index.js").TypeSchema} InternalTypeDetails
+ * @typedef {import("./Lib.js").CompileOptions} CompileOptions
+ * @typedef {import("./Lib.js").CompileOutput} CompileOutput
+ * @typedef {import("./Lib.js").Lib} Lib
+ * @typedef {import("./Lib.js").SourceDetails} SourceDetails
  */
 
+import { bytesToHex } from "@helios-lang/compiler"
+import { readHeader } from "@helios-lang/compiler-utils"
+import { UplcProgramV1 } from "@helios-lang/uplc"
+
 /**
  * @typedef {{
  *   [name: string]: string[]
@@ -339,4 +342,102 @@ export class Lib_v0_16 {
             }
         }
     }
+
+    /**
+     * @param {string} main
+     * @param {string[]} modules
+     * @param {CompileOptions} options
+     * @returns {CompileOutput}
+     */
+    compile(main, modules, options) {
+        const [purpose, name] = readHeader(main)
+        const otherValidators = options.otherValidators ?? {}
+        const otherValidatorTypes = Object.fromEntries(
+            Object.keys(otherValidators).map((k) => {
+                return [k, this.getValidatorType(otherValidators[k].purpose)]
+            })
+        )
+
+        const program = this.lib.Program.newInternal(
+            main,
+            modules,
+            otherValidatorTypes,
+            {
+                allowPosParams: false,
+                invertEntryPoint: true
+            }
+        )
+
+        /**
+         * @type {Map<any, any>}
+         */
+        const extra = new Map()
+        const IR = this.lib.IR
+
+        if (options.ownHash) {
+            const key = `__helios__scripts__${name}`
+
+            extra.set(key, new IR(`#${options.ownHash}`))
+        } else if (options.dependsOnOwnHash) {
+            const key = `__helios__scripts__${name}`
+            let ir = new IR(`__PARAM_${program.nPosParams - 1}`)
+
+            switch (purpose) {
+                case "spending":
+                    ir = new IR([
+                        new IR(
+                            `__helios__scriptcontext__get_current_validator_hash(`
+                        ),
+                        ir,
+                        new IR(`)()`)
+                    ])
+                    break
+                case "minting":
+                    ir = new IR([
+                        new IR(
+                            `__helios__scriptcontext__get_current_minting_policy_hash(`
+                        ),
+                        ir,
+                        new IR(`)()`)
+                    ])
+                    break
+                default:
+                    throw new Error("unhandled purpose")
+            }
+
+            extra.set(key, ir)
+        }
+
+        for (let other in otherValidators) {
+            const key = `__helios__scripts__${other}`
+
+            extra.set(key, new IR(`#${otherValidators[other]}`))
+        }
+
+        const optimize = options.optimize
+        const ir = program.toIR(new this.lib.ToIRContext(optimize), extra)
+
+        if (program.nPosParams > 0) {
+            const irProgram = this.lib.IRParametricProgram.new(
+                ir,
+                purpose,
+                program.nPosParams,
+                optimize
+            )
+
+            const cborHex = bytesToHex(irProgram.toUplc().toCbor())
+
+            return {
+                cborHex
+            }
+        } else {
+            const irProgram = this.lib.IRProgram.new(ir, purpose, optimize)
+
+            const cborHex = bytesToHex(irProgram.toUplc().toCbor())
+
+            return {
+                cborHex
+            }
+        }
+    }
 }

package/src/lib/load.js

@@ -1,5 +1,4 @@
-import { existsSync } from "node:fs"
-import { dirname, join } from "node:path"
+import * as lib from "@helios-lang/compiler"
 import { getVersion } from "./Lib.js"
 import { Lib_v0_16 } from "./Libg_v0_16.js"
 
@@ -8,54 +7,18 @@ import { Lib_v0_16 } from "./Libg_v0_16.js"
  */
 
 /**
- * @returns {string}
+ * @returns {Lib}
  */
-function findRootDir() {
-    let dir = process.cwd()
-
-    while (dir != "/") {
-        if (existsSync(join(dir, "package.json"))) {
-            return dir
-        } else {
-            dir = dirname(dir)
-        }
-    }
-
-    throw new Error("package.json not found")
-}
-
-/**
- * @returns {Promise<Lib>}
- */
-export async function loadLibrary() {
-    const rootDir = findRootDir()
-
-    const packageNames = ["@hyperionbt/helios/helios.js"]
-
-    for (let packageName of packageNames) {
-        try {
-            const lib = await eval(
-                `import("${rootDir}/node_modules/${packageName}")`
-            )
-
-            const [major, minor] = getVersion(lib)
-
-            switch (major) {
-                case 0:
-                    switch (minor) {
-                        case 16:
-                            return new Lib_v0_16(lib)
-                    }
-                default:
-                    throw new Error(
-                        `compiler version ${lib.VERSION} not supported`
-                    )
+export function loadLibrary() {
+    const [major, minor] = getVersion(lib)
+
+    switch (major) {
+        case 0:
+            switch (minor) {
+                case 16:
+                    return new Lib_v0_16(lib)
             }
-        } catch (_e) {
-            console.error(_e)
-            continue
-        }
+        default:
+            throw new Error(`compiler version ${lib.VERSION} not supported`)
     }
-
-    throw new Error("compiler not installed")
 }

package/src/runtime/Cast.js

@@ -36,8 +36,8 @@ import {
  */
 
 /**
- * @template TStrict
- * @template TPermissive
+ * @template [TStrict=UplcData]
+ * @template [TPermissive=UplcData]
  */
 export class Cast {
     /**
@@ -57,7 +57,7 @@ export class Cast {
      * @param {UplcData} data
      * @returns {TStrict}
      */
-    fromUplc(data) {
+    fromUplcData(data) {
         return uplcToSchema(this.schema, data)
     }
 
@@ -65,7 +65,7 @@ export class Cast {
      * @param {TPermissive} x
      * @returns {UplcData}
      */
-    toUplc(x) {
+    toUplcData(x) {
         return schemaToUplc(this.schema, x)
     }
 }
@@ -167,8 +167,11 @@ function schemaToUplc(schema, x) {
         const tag = schema.enumVariantTypes.findIndex(
             (v) => v.name == variantName
         )
-        if (tag != -1) {
-            throw new Error("invalid variant")
+
+        if (tag == -1) {
+            throw new Error(
+                `invalid variant ${variantName} (expected: ${schema.enumVariantTypes.map((v) => v.name).join(", ")})`
+            )
         }
 
         return new ConstrData(

package/src/runtime/ContractContext.js

@@ -0,0 +1,35 @@
+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
+    }
+}