* cip68 struct tagging documented

Hyperion-BT · Aug 22, 2023 · 81cf0b0 · 81cf0b0
1 parent cb073e0
commit 81cf0b0
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 6 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@hyperionbt/helios": "^0.15.4",
+    "@hyperionbt/helios": "^0.15.7",
     "@jsdoc/ast": "^0.2.1",
     "@jsdoc/parse": "^0.3.1",
     "typedoc": "^0.24.8",

diff --git a/src/lang/structs.md b/src/lang/structs.md
@@ -24,4 +24,30 @@ The fields can also be named:
 
 ```helios
 const x = Rational { bottom: 3, top: 1 }
-```
+```
+
+## CIP 68 tags
+
+Regular Helios structs are internally implemented as data-lists. 
+
+This internal data-list format isn't convenient for datums that are intended for public reading/writing. For such applications it is recommended to use the [CIP 68](https://cips.cardano.org/cips/cip68/) data-map format.
+
+Helios will automatically use the [CIP 68](https://cips.cardano.org/cips/cip68/) format internally if any `struct` field is tagged. The tags are internally converted into the data-map keys.
+
+```helios
+struct TaggedRational {
+    top:    Int "@top"     // the tag can be any valid utf-8 string
+    bottom: Int "@bottom"
+}
+```
+
+Any missing tags default to the field name:
+
+```helios
+struct TaggedRational {
+    top:    Int "@top"
+    bottom: Int         // data-map key will be "bottom"
+}
+```
+
+Field tagging isn't available for enum variants.