@helios-lang/contract-utils 0.1.41 → 0.2.0

package/examples/multi-validator/contract.js

@@ -1,5 +1,6 @@
 import { ContractContextBuilder } from "@helios-lang/contract-utils"
-import { Address, AssetClass, TxBuilder } from "@helios-lang/ledger"
+import { Address, AssetClass } from "@helios-lang/ledger"
+import { TxBuilder } from "@helios-lang/tx-utils"
 import { match_string, match_string_policy } from "./index.js"
 
 export function createApp() {
@@ -7,17 +8,20 @@ export function createApp() {
         .with(match_string)
         .with(match_string_policy)
         .build({
-            match_string_policy:
-                "f7c8a87011f1aec5967dd3cd68b7a2c26135d750867bfd957b4d8967" // expected hash for match_string_policy
+            isMainnet: false,
+            expectedHashes: {
+                match_string_policy:
+                    "f7c8a87011f1aec5967dd3cd68b7a2c26135d750867bfd957b4d8967" // expected hash for match_string_policy
+            }
         })
 
-    console.log(context.match_string_policy.toHex())
+    console.log(context.match_string_policy.$hash.toHex())
 
-    const assetClass = new AssetClass(context.match_string_policy, [])
+    const assetClass = new AssetClass(context.match_string_policy.$hash, [])
 
-    const address = Address.fromHash(context.match_string)
+    const address = Address.fromHash(false, context.match_string.$hash)
 
-    let b = new TxBuilder().mint(assetClass, 10, true)
+    let b = TxBuilder.new({ isMainnet: false }).mint(assetClass, 10, true)
 
     let c = b
         .pay(address, 1_000_000n, { hash: { One: { message: "hello" } } })

package/examples/multi-validator/index.d.ts

@@ -1,12 +1,18 @@
-import type {UplcData} from "@helios-lang/ledger";
-import { Address, AssetClass, DatumHash, MintingPolicyHash, PubKey, PubKeyHash, SpendingCredential, StakingCredential, StakingHash, StakingValidatorHash, TimeRange, TxId, TxOutputDatum, ValidatorHash, Value } from "@helios-lang/ledger";
 import { Cast } from "@helios-lang/contract-utils";
+import { Address, AssetClass, DatumHash, MintingPolicyHash, PubKey, PubKeyHash, SpendingCredential, StakingCredential, StakingHash, StakingValidatorHash, TimeRange, TxId, TxOutputDatum, ValidatorHash, Value } from "@helios-lang/ledger";
+import type { IntLike } from "@helios-lang/codec-utils";
+import type { CastConfig } from "@helios-lang/contract-utils";
+import type { ConfigurableCast } from "@helios-lang/contract-utils";
+import type { TimeLike } from "@helios-lang/ledger";
+import type { UplcData } from "@helios-lang/ledger";
 export const utils: {
-    $name: string
-    $purpose: string
+    $name: "utils"
+    $purpose: "module"
     $sourceCode: string
     $dependencies: [],
-    MyUtilType: Cast<{hello: bigint}, {hello: bigint | number | string}>,
+    $types: {
+        MyUtilType: ConfigurableCast<{hello: bigint}, {hello: IntLike}>,
+    },
 }
 export const match_string_policy: {
     $name: "match_string_policy"
@@ -15,7 +21,9 @@ export const match_string_policy: {
     $dependencies: []
     $hashDependencies: []
     $dependsOnOwnHash: boolean
-    $Redeemer: Cast<boolean, boolean>
+    $Redeemer: ConfigurableCast<boolean, boolean>
+    $types: {
+    },
 }
 export const match_string: {
     $name: "match_string"
@@ -24,7 +32,9 @@ export const match_string: {
     $dependencies: [typeof utils]
     $hashDependencies: [typeof match_string_policy]
     $dependsOnOwnHash: boolean
-    $Redeemer: Cast<string, string>
-    $Datum: Cast<{One: {message: string}} | {Two: {code: bigint}}, {One: {message: string}} | {Two: {code: bigint | number | string}}>,
-    Datum: Cast<{One: {message: string}} | {Two: {code: bigint}}, {One: {message: string}} | {Two: {code: bigint | number | string}}>,
+    $Redeemer: ConfigurableCast<string, string>
+    $Datum: ConfigurableCast<{One: {message: string}} | {Two: {code: bigint}}, {One: {message: string}} | {Two: {code: IntLike}}>,
+    $types: {
+        Datum: ConfigurableCast<{One: {message: string}} | {Two: {code: bigint}}, {One: {message: string}} | {Two: {code: IntLike}}>,
+    },
 }

package/examples/multi-validator/index.js

@@ -1,28 +1,52 @@
 import { Cast } from "@helios-lang/contract-utils";
+import { Address, AssetClass, DatumHash, MintingPolicyHash, PubKey, PubKeyHash, SpendingCredential, StakingCredential, StakingHash, StakingValidatorHash, TimeRange, TxId, TxOutputDatum, ValidatorHash, Value } from "@helios-lang/ledger";
+/**
+ * @typedef {import("@helios-lang/codec-utils").IntLike} IntLike
+ */
+/**
+ * @typedef {import("@helios-lang/contract-utils").CastConfig} CastConfig
+ */
+/**
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {import("@helios-lang/contract-utils").ConfigurableCast<TStrict, TPermissive>} ConfigurableCast
+ */
+/**
+ * @typedef {import("@helios-lang/ledger").TimeLike} TimeLike
+ */
+/**
+ * @typedef {import("@helios-lang/ledger").UplcData} UplcData
+ */
 export const utils = {
-    $name: "utils",
-    $purpose: "module",
+    $name: /** @type {const} */ ("utils"),
+    $purpose: /** @type {const} */ ("module"),
     $sourceCode: "module utils\n\nstruct MyUtilType {\n    hello: Int\n}\n\nconst my_assetclass: AssetClass = AssetClass::new(Scripts::match_string_policy, #)\n\nconst my_hash: ValidatorHash = Scripts::match_string\n\nfunc compare(a: String, b: String) -> Bool {\n    a == b\n}",
-    $dependencies: [],
-    MyUtilType: new Cast({"structFieldTypes":[{"name":"hello","type":{"primitiveType":"Int"}}]}),
+    $dependencies: /** @type {const} */ ([]),
+    $types: {
+        MyUtilType: (config) => /** @type {Cast<{hello: bigint}, {hello: IntLike}>} */ (new Cast({"structFieldTypes":[{"name":"hello","type":{"primitiveType":"Int"}}]}, config)),
+    },
 }
 export const match_string_policy = {
-    $name: "match_string_policy",
-    $purpose: "minting",
+    $name: /** @type {const} */ ("match_string_policy"),
+    $purpose: /** @type {const} */ ("minting"),
     $sourceCode: "minting match_string_policy\n\nfunc main(redeemer: Bool, _) -> Bool {\n    redeemer\n}",
-    $dependencies: [],
+    $dependencies: /** @type {const} */ ([]),
     $hashDependencies: [],
     $dependsOnOwnHash: false,
-    $Redeemer: new Cast({"primitiveType":"Bool"}),
+    $Redeemer: (config) => /** @type {Cast<boolean, boolean>} */ (new Cast({"primitiveType":"Bool"}, config)),
+    $types: {
+    },
 }
 export const match_string = {
-    $name: "match_string",
-    $purpose: "spending",
+    $name: /** @type {const} */ ("match_string"),
+    $purpose: /** @type {const} */ ("spending"),
     $sourceCode: "spending match_string\n\nimport { compare, my_assetclass } 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, ctx: ScriptContext) -> Bool {\n compare(datum.switch{d: One => d.message, d: Two => d.code.show()}, redeemer) &&\n   ctx.tx.minted.get(my_assetclass) > 0\n}",
-    $dependencies: [utils],
+    $dependencies: /** @type {const} */ ([utils]),
     $hashDependencies: [match_string_policy],
     $dependsOnOwnHash: true,
-    $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"}}]}]}),
-    Datum: new Cast({"enumVariantTypes":[{"name":"One","fieldTypes":[{"name":"message","type":{"primitiveType":"String"}}]},{"name":"Two","fieldTypes":[{"name":"code","type":{"primitiveType":"Int"}}]}]}),
+    $Redeemer: (config) => /** @type {Cast<string, string>} */ (new Cast({"primitiveType":"String"}, config)),
+    $Datum: (config) => /** @type {Cast<{One: {message: string}} | {Two: {code: bigint}}, {One: {message: string}} | {Two: {code: IntLike}}>} */ new Cast({"enumVariantTypes":[{"name":"One","fieldTypes":[{"name":"message","type":{"primitiveType":"String"}}]},{"name":"Two","fieldTypes":[{"name":"code","type":{"primitiveType":"Int"}}]}]}, config),
+    $types: {
+        Datum: (config) => /** @type {Cast<{One: {message: string}} | {Two: {code: bigint}}, {One: {message: string}} | {Two: {code: IntLike}}>} */ (new Cast({"enumVariantTypes":[{"name":"One","fieldTypes":[{"name":"message","type":{"primitiveType":"String"}}]},{"name":"Two","fieldTypes":[{"name":"code","type":{"primitiveType":"Int"}}]}]}, config)),
+    },
 }

package/examples/multi-validator/package-lock.json

@@ -7,6 +7,7 @@
       "name": "spending_example",
       "dependencies": {
         "@helios-lang/contract-utils": "file:../..",
+        "@helios-lang/tx-utils": "^0.1.38",
         "@hyperionbt/helios": "^0.16.7"
       },
       "devDependencies": {
@@ -15,14 +16,15 @@
     },
     "../..": {
       "name": "@helios-lang/contract-utils",
-      "version": "0.1.23",
+      "version": "0.1.41",
       "license": "BSD-3-Clause",
       "dependencies": {
-        "@helios-lang/codec-utils": "^0.1.27",
-        "@helios-lang/compiler-utils": "^0.1.21",
-        "@helios-lang/ledger": "^0.1.21",
+        "@helios-lang/cli-utils": "^0.1.4",
+        "@helios-lang/codec-utils": "^0.1.29",
+        "@helios-lang/compiler-utils": "^0.1.22",
+        "@helios-lang/ledger": "^0.2.1",
         "@helios-lang/type-utils": "^0.1.8",
-        "@helios-lang/uplc": "^0.1.22"
+        "@helios-lang/uplc": "^0.1.27"
       },
       "bin": {
         "hl2ts": "src/hl2ts.js"
@@ -36,10 +38,82 @@
         "@helios-lang/compiler": "*"
       }
     },
+    "node_modules/@helios-lang/cbor": {
+      "version": "0.1.18",
+      "resolved": "https://registry.npmjs.org/@helios-lang/cbor/-/cbor-0.1.18.tgz",
+      "integrity": "sha512-DgHJ4PQJqGKBLSnRD3PkZ0QjSzYrQIinEuVyK5XsdLS/s95z5/2rkPxd9v/VvbfAHdZlYT1fsV3Ei/pblxuJXw==",
+      "dependencies": {
+        "@helios-lang/codec-utils": "^0.1.29",
+        "@helios-lang/type-utils": "^0.1.8"
+      }
+    },
+    "node_modules/@helios-lang/codec-utils": {
+      "version": "0.1.29",
+      "resolved": "https://registry.npmjs.org/@helios-lang/codec-utils/-/codec-utils-0.1.29.tgz",
+      "integrity": "sha512-Faa9AlB61BSed3fZ8T5t/hljeJP7tWdqPOuuAKMJPoyDIPdNhMesux0jZMRTyQByKEXE2DSq3TFvQCeAsE6zng=="
+    },
+    "node_modules/@helios-lang/compiler-utils": {
+      "version": "0.1.22",
+      "resolved": "https://registry.npmjs.org/@helios-lang/compiler-utils/-/compiler-utils-0.1.22.tgz",
+      "integrity": "sha512-y2BEe5Gnnag7UGFTj+mOb2GdlYvuLaaBwekgHe+tFf1HYuyhfIFdSOyRdALYnh+LjQhcFhxgHzob55uyfTxdHQ==",
+      "dependencies": {
+        "@helios-lang/codec-utils": "^0.1.29",
+        "@helios-lang/type-utils": "^0.1.8"
+      }
+    },
     "node_modules/@helios-lang/contract-utils": {
       "resolved": "../..",
       "link": true
     },
+    "node_modules/@helios-lang/crypto": {
+      "version": "0.1.8",
+      "resolved": "https://registry.npmjs.org/@helios-lang/crypto/-/crypto-0.1.8.tgz",
+      "integrity": "sha512-06ak82XadShfEguohj9bgnlI9Dxol1Hq9s1njP7F6UJwEL3WIvm/DrMGvHzx0+jg1s50WHl2SqZnA5CC+GLdKA==",
+      "dependencies": {
+        "@helios-lang/codec-utils": "^0.1.29"
+      }
+    },
+    "node_modules/@helios-lang/ledger": {
+      "version": "0.2.1",
+      "resolved": "https://registry.npmjs.org/@helios-lang/ledger/-/ledger-0.2.1.tgz",
+      "integrity": "sha512-un7pUstnpiboq3fnuIkls4tedO42febiY8s4tH/qEgVLtYz3TV3gicjwg36Bc8ff//CoUabhS3syOcgK0QNKXQ==",
+      "dependencies": {
+        "@helios-lang/cbor": "^0.1.18",
+        "@helios-lang/codec-utils": "^0.1.29",
+        "@helios-lang/crypto": "^0.1.8",
+        "@helios-lang/type-utils": "^0.1.8",
+        "@helios-lang/uplc": "^0.1.27"
+      }
+    },
+    "node_modules/@helios-lang/tx-utils": {
+      "version": "0.1.38",
+      "resolved": "https://registry.npmjs.org/@helios-lang/tx-utils/-/tx-utils-0.1.38.tgz",
+      "integrity": "sha512-Qbcgtpv8UpbL3bqBEfNG8DMx1ts8TK1KHMRlp9HlBkTMPfWvyoV1R+BLicCLN0fcMFxeG+pVuOgZFK9dG7TQ2Q==",
+      "dependencies": {
+        "@helios-lang/codec-utils": "^0.1.29",
+        "@helios-lang/crypto": "^0.1.8",
+        "@helios-lang/ledger": "^0.2.1",
+        "@helios-lang/type-utils": "^0.1.8",
+        "@helios-lang/uplc": "^0.1.27"
+      }
+    },
+    "node_modules/@helios-lang/type-utils": {
+      "version": "0.1.8",
+      "resolved": "https://registry.npmjs.org/@helios-lang/type-utils/-/type-utils-0.1.8.tgz",
+      "integrity": "sha512-zVGgJvNQHWuFfK1HLybynp6RAO31yIPkEp/ztdJJcdKS3TOVaUVAr3XHaFY8Hk2Pr7qO0lD2rvfl3Hkk+GApwQ=="
+    },
+    "node_modules/@helios-lang/uplc": {
+      "version": "0.1.27",
+      "resolved": "https://registry.npmjs.org/@helios-lang/uplc/-/uplc-0.1.27.tgz",
+      "integrity": "sha512-WqFMpc2/SvZyX0ubsw/uNI+kMIK539QbeCAOXIVdDkotqC8qqXf+MeFqRepSe5T2luY1dhTnUqlRrYExd6dmvg==",
+      "dependencies": {
+        "@helios-lang/cbor": "^0.1.18",
+        "@helios-lang/codec-utils": "^0.1.29",
+        "@helios-lang/compiler-utils": "^0.1.22",
+        "@helios-lang/crypto": "^0.1.8",
+        "@helios-lang/type-utils": "^0.1.8"
+      }
+    },
     "node_modules/@hyperionbt/helios": {
       "version": "0.16.7",
       "resolved": "https://registry.npmjs.org/@hyperionbt/helios/-/helios-0.16.7.tgz",

package/examples/multi-validator/package.json

@@ -3,6 +3,7 @@
   "type": "module",
   "dependencies": {
     "@helios-lang/contract-utils": "file:../..",
+    "@helios-lang/tx-utils": "^0.1.38",
     "@hyperionbt/helios": "^0.16.7"
   },
   "devDependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@helios-lang/contract-utils",
-    "version": "0.1.41",
+    "version": "0.2.0",
     "description": "Convenience and type-safety utilities for using Helios validators from within Typescript",
     "main": "src/index.js",
     "types": "types/index.d.ts",
@@ -38,7 +38,7 @@
         "@helios-lang/cli-utils": "^0.1.4",
         "@helios-lang/codec-utils": "^0.1.29",
         "@helios-lang/compiler-utils": "^0.1.22",
-        "@helios-lang/ledger": "^0.1.49",
+        "@helios-lang/ledger": "^0.2.1",
         "@helios-lang/type-utils": "^0.1.8",
         "@helios-lang/uplc": "^0.1.27"
     }

package/src/cast/Cast.js

@@ -38,8 +38,27 @@ import {
  */
 
 /**
- * @template [TStrict=any]
- * @template [TPermissive=any]
+ * @typedef {{
+ *   isMainnet: boolean
+ * }} CastConfig
+ */
+
+/**
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {(config: CastConfig) => Cast<TStrict, TPermissive>} ConfigurableCast
+ */
+
+/**
+ * StrictType and PermissiveType work for both Cast and ConfigurableCast
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {Cast<TStrict, TPermissive> | ConfigurableCast<TStrict, TPermissive>} CastLike
+ */
+
+/**
+ * @template TStrict
+ * @template TPermissive
  */
 export class Cast {
     /**
@@ -48,11 +67,19 @@ export class Cast {
      */
     schema
 
+    /**
+     * @readonly
+     * @type {CastConfig}
+     */
+    config
+
     /**
      * @param {TypeSchema} schema
+     * @param {CastConfig} config
      */
-    constructor(schema) {
+    constructor(schema, config) {
         this.schema = schema
+        this.config = config
     }
 
     /**
@@ -60,7 +87,7 @@ export class Cast {
      * @returns {TStrict}
      */
     fromUplcData(data) {
-        return uplcToSchema(this.schema, data)
+        return uplcToSchema(this.schema, data, this.config)
     }
 
     /**
@@ -196,13 +223,14 @@ function schemaToUplc(schema, x) {
  * This should fail when deviating
  * @param {TypeSchema} schema
  * @param {UplcData} data
+ * @param {CastConfig} config
  * @returns {any}
  */
-function uplcToSchema(schema, data) {
+function uplcToSchema(schema, data, config) {
     if ("primitiveType" in schema) {
         switch (schema.primitiveType) {
             case "Address":
-                return Address.fromUplcData(data)
+                return Address.fromUplcData(config.isMainnet, data)
             case "Any":
                 // TODO: should this throw an error?
                 return null
@@ -257,19 +285,19 @@ function uplcToSchema(schema, data) {
         }
     } else if ("listItemType" in schema) {
         return ListData.expect(data).items.map((x) =>
-            uplcToSchema(schema.listItemType, x)
+            uplcToSchema(schema.listItemType, x, config)
         )
     } else if ("mapKeyType" in schema) {
         return new Map(
             MapData.expect(data).items.map(([k, v]) => [
-                uplcToSchema(schema.mapKeyType, k),
-                uplcToSchema(schema.mapValueType, v)
+                uplcToSchema(schema.mapKeyType, k, config),
+                uplcToSchema(schema.mapValueType, v, config)
             ])
         )
     } else if ("optionSomeType" in schema) {
         const optionData = decodeOptionData(data)
         return optionData
-            ? uplcToSchema(schema.optionSomeType, optionData)
+            ? uplcToSchema(schema.optionSomeType, optionData, config)
             : None
     } else if ("structFieldTypes" in schema) {
         const nExpected = schema.structFieldTypes.length
@@ -278,7 +306,8 @@ function uplcToSchema(schema, data) {
             return {
                 [schema.structFieldTypes[0].name]: uplcToSchema(
                     schema.structFieldTypes[0].type,
-                    data
+                    data,
+                    config
                 )
             }
         } else {
@@ -293,7 +322,7 @@ function uplcToSchema(schema, data) {
             return Object.fromEntries(
                 fields.map((field, i) => [
                     schema.structFieldTypes[i].name,
-                    uplcToSchema(schema.structFieldTypes[i].type, field)
+                    uplcToSchema(schema.structFieldTypes[i].type, field, config)
                 ])
             )
         }
@@ -318,7 +347,7 @@ function uplcToSchema(schema, data) {
             [variantSchema.name]: Object.fromEntries(
                 fields.map((f, i) => [
                     variantSchema.fieldTypes[i].name,
-                    uplcToSchema(variantSchema.fieldTypes[i].type, f)
+                    uplcToSchema(variantSchema.fieldTypes[i].type, f, config)
                 ])
             )
         }
@@ -328,3 +357,18 @@ function uplcToSchema(schema, data) {
         )
     }
 }
+
+/**
+ * @template TStrict
+ * @template TPermissive
+ * @param {CastLike<TStrict, TPermissive>} cast
+ * @param {CastConfig} config
+ * @returns {Cast<TStrict, TPermissive>}
+ */
+export function configureCast(cast, config) {
+    if (cast instanceof Cast) {
+        return cast
+    } else {
+        return cast(config)
+    }
+}

package/src/cast/PermissiveType.js

@@ -1,6 +1,18 @@
-import { Cast } from "./Cast.js"
+export {}
 
 /**
- * @template {Cast} C
- * @typedef {C extends Cast<any, infer TPermissive> ? TPermissive : never} PermissiveType
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {import("./Cast.js").ConfigurableCast<TStrict, TPermissive>} ConfigurableCast
+ */
+
+/**
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {import("./Cast.js").CastLike<TStrict, TPermissive>} CastLike
+ */
+
+/**
+ * @template {CastLike<any, any>} C
+ * @typedef {C extends CastLike<any, infer TPermissive> ? TPermissive : never} PermissiveType
  */

package/src/cast/StrictType.js

@@ -1,6 +1,18 @@
-import { Cast } from "./Cast.js"
+export {}
 
 /**
- * @template {Cast} C
- * @typedef {C extends Cast<infer TStrict, any> ? TStrict : never} StrictType
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {import("./Cast.js").ConfigurableCast<TStrict, TPermissive>} ConfigurableCast
+ */
+
+/**
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {import("./Cast.js").CastLike<TStrict, TPermissive>} CastLike
+ */
+
+/**
+ * @template {CastLike<any, any>} C
+ * @typedef {C extends CastLike<infer TStrict, any> ? TStrict : never} StrictType
  */

package/src/cast/index.js

@@ -1,12 +1,29 @@
 import { Cast } from "./Cast.js"
 export { Cast }
+export { configureCast } from "./Cast.js"
 
 /**
- * @template {Cast} C
+ * @typedef {import("./Cast.js").CastConfig} CastConfig
+ */
+
+/**
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {import("./Cast.js").ConfigurableCast<TStrict, TPermissive>} ConfigurableCast
+ */
+
+/**
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {import("./Cast.js").CastLike<TStrict, TPermissive>} CastLike
+ */
+
+/**
+ * @template {CastLike<any, any>} C
  * @typedef {import("./PermissiveType.js").PermissiveType<C>} PermissiveType
  */
 
 /**
- * @template {Cast} C
+ * @template {CastLike<any, any>} C
  * @typedef {import("./StrictType.js").StrictType<C>} StrictType
  */

package/src/codegen/LoadedModule.js

@@ -1,9 +1,17 @@
 export {}
 
+/**
+ * @template TStrict
+ * @template TPermissive
+ * @typedef {import("../cast/Cast.js").CastLike<TStrict, TPermissive>} CastLike
+ */
+
 /**
  * @typedef {{
  *   $name: string
+ *   $purpose: "module"
  *   $sourceCode: string
- *   $dependencies: LoadedModule[]
+ *   $dependencies: ReadonlyArray<LoadedModule>
+ *   $types: {[name: string]: CastLike<any, any>}
  * }} LoadedModule
  */