CDDL: Consolidate scripts across all eras.

* Make native_script fields era-prefixed as and when they are introduced
* Add smart constructors for script types in core
* Fix script_n_of_k for eras after allegra

Author: aniketd

eras/allegra/impl/CHANGELOG.md

@@ -11,6 +11,7 @@
 
 ### `testlib`
 
+* Rename `native_script` -> `allegra_native_script` in CDDL
 * Add `auxiliary_data_array` to CDDL for simplification
 * Remove `metadata` redefinition in CDDL
 * Use fixed-sized `uint .size 8` for `slot` in CDDL for timelock validity intervals

eras/allegra/impl/cddl-files/allegra.cddl

@@ -145,11 +145,12 @@ hash28 = bytes .size 28
 ; To compute a script hash, note that you must prepend
 ; a tag to the bytes of the script before hashing.
 ; The tag is determined by the language.
-; The tags in the Conway era are:
-;   "\x00" for multisig scripts
+; The tags are:
+;   "\x00" for multisig/native scripts
 ;   "\x01" for Plutus V1 scripts
 ;   "\x02" for Plutus V2 scripts
 ;   "\x03" for Plutus V3 scripts
+;   "\x04" for Plutus V4 scripts
 script_hash = hash28
 
 ; This will be deprecated in a future era
@@ -286,13 +287,15 @@ transaction_witness_set =
 
 vkeywitness = [vkey, signature]
 
-; Timelock validity intervals are half-open intervals [a, b).
+; Allegra introduces timelock support for native scripts.
+; This is the 6-variant native script format used by
+; Allegra, Mary, Alonzo, Babbage, and Conway.
 ; 
-;   invalid_before:
-;     specifies the left (included) endpoint a.
+; Timelock validity intervals are half-open intervals [a, b).
+;   invalid_before: specifies the left (included) endpoint a.
+;   invalid_hereafter: specifies the right (excluded) endpoint b.
 ; 
-;   invalid_hereafter:
-;     specifies the right (excluded) endpoint b.
+; Note: Allegra switched to int64 for script_n_of_k thresholds.
 native_script = 
   [  script_pubkey
   // script_all
@@ -317,8 +320,12 @@ min_int64 = -9223372036854775808
 
 max_int64 = 9223372036854775807
 
+; Timelock validity intervals are half-open intervals [a, b).
+; This field specifies the left (included) endpoint a.
 invalid_before = (4, slot)
 
+; Timelock validity intervals are half-open intervals [a, b).
+; This field specifies the right (excluded) endpoint b.
 invalid_hereafter = (5, slot)
 
 bootstrap_witness = 

eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/CDDL.hs

@@ -17,11 +17,7 @@ module Test.Cardano.Ledger.Allegra.CDDL (
   auxiliary_data,
   auxiliary_data_array,
   auxiliary_scripts,
-  script_pubkey,
-  script_all,
-  script_any,
-  invalid_before,
-  invalid_hereafter,
+  allegra_native_script,
 ) where
 
 import Cardano.Ledger.Allegra (AllegraEra)
@@ -38,16 +34,18 @@ allegraCDDL =
     , HIRule $ transaction @AllegraEra
     ]
 
-native_script :: Rule
-native_script =
+allegra_native_script :: Rule
+allegra_native_script =
   comment
-    [str|Timelock validity intervals are half-open intervals [a, b).
+    [str|Allegra introduces timelock support for native scripts.
+        |This is the 6-variant native script format used by
+        |Allegra, Mary, Alonzo, Babbage, and Conway.
         |
-        |  invalid_before:
-        |    specifies the left (included) endpoint a.
+        |Timelock validity intervals are half-open intervals [a, b).
+        |  invalid_before: specifies the left (included) endpoint a.
+        |  invalid_hereafter: specifies the right (excluded) endpoint b.
         |
-        |  invalid_hereafter:
-        |    specifies the right (excluded) endpoint b.
+        |Note: Allegra switched to int64 for script_n_of_k thresholds.
         |]
     $ "native_script"
       =:= arr [a script_pubkey]
@@ -58,25 +56,25 @@ native_script =
       / arr [a invalid_hereafter]
 
 script_pubkey :: Named Group
-script_pubkey = "script_pubkey" =:~ grp [0, a addr_keyhash]
+script_pubkey = mkScriptPubkey
 
 script_all :: Named Group
-script_all = "script_all" =:~ grp [1, a (arr [0 <+ a native_script])]
+script_all = mkScriptAll allegra_native_script
 
 script_any :: Named Group
-script_any = "script_any" =:~ grp [2, a (arr [0 <+ a native_script])]
+script_any = mkScriptAny allegra_native_script
 
 script_n_of_k :: Named Group
-script_n_of_k = "script_n_of_k" =:~ grp [3, "n" ==> int64, a (arr [0 <+ a native_script])]
+script_n_of_k = mkScriptNOfK int64 allegra_native_script
 
 invalid_before :: Named Group
-invalid_before = "invalid_before" =:~ grp [4, a slot]
+invalid_before = mkInvalidBefore
 
 invalid_hereafter :: Named Group
-invalid_hereafter = "invalid_hereafter" =:~ grp [5, a slot]
+invalid_hereafter = mkInvalidHereafter
 
 auxiliary_scripts :: Rule
-auxiliary_scripts = "auxiliary_scripts" =:= arr [0 <+ a native_script]
+auxiliary_scripts = "auxiliary_scripts" =:= arr [0 <+ a allegra_native_script]
 
 auxiliary_data_array :: Rule
 auxiliary_data_array =
@@ -134,6 +132,6 @@ transaction_witness_set =
   "transaction_witness_set"
     =:= mp
       [ opt $ idx 0 ==> arr [0 <+ a vkeywitness]
-      , opt $ idx 1 ==> arr [0 <+ a native_script]
+      , opt $ idx 1 ==> arr [0 <+ a allegra_native_script]
       , opt $ idx 2 ==> arr [0 <+ a bootstrap_witness]
       ]

eras/alonzo/impl/CHANGELOG.md

@@ -25,6 +25,8 @@
 
 ### `testlib`
 
+* Rename `plutus_script` -> `plutus_v1_script` in CDDL
+* Add `plutus_v1_script` to CDDL exports
 * Add `auxiliary_data_map` to CDDL for simplification
 * Remove redefinition of `auxiliary_data_hash` from CDDL
 * Use fixed-sized `uint .size 8` for `slot` and `block_number` in CDDL for header

eras/alonzo/impl/cddl-files/alonzo.cddl

@@ -153,11 +153,12 @@ policy_id = script_hash
 ; To compute a script hash, note that you must prepend
 ; a tag to the bytes of the script before hashing.
 ; The tag is determined by the language.
-; The tags in the Conway era are:
-;   "\x00" for multisig scripts
+; The tags are:
+;   "\x00" for multisig/native scripts
 ;   "\x01" for Plutus V1 scripts
 ;   "\x02" for Plutus V2 scripts
 ;   "\x03" for Plutus V3 scripts
+;   "\x04" for Plutus V4 scripts
 script_hash = hash28
 
 hash28 = bytes .size 28
@@ -436,28 +437,30 @@ network_id = 0/ 1
 
 ; 
 ; NEW:
-;   3: [* plutus_script ]
+;   3: [* plutus_v1_script ]
 ;   4: [* plutus_data ]
 ;   5: redeemers
 transaction_witness_set = 
   { ? 0 : [* vkeywitness]      
   , ? 1 : [* native_script]    
   , ? 2 : [* bootstrap_witness]
-  , ? 3 : [* plutus_script]    
+  , ? 3 : [* plutus_v1_script] 
   , ? 4 : [* plutus_data]      
   , ? 5 : redeemers                
   }
 
 
 vkeywitness = [vkey, signature]
 
-; Timelock validity intervals are half-open intervals [a, b).
+; Allegra introduces timelock support for native scripts.
+; This is the 6-variant native script format used by
+; Allegra, Mary, Alonzo, Babbage, and Conway.
 ; 
-;   invalid_before:
-;     specifies the left (included) endpoint a.
+; Timelock validity intervals are half-open intervals [a, b).
+;   invalid_before: specifies the left (included) endpoint a.
+;   invalid_hereafter: specifies the right (excluded) endpoint b.
 ; 
-;   invalid_hereafter:
-;     specifies the right (excluded) endpoint b.
+; Note: Allegra switched to int64 for script_n_of_k thresholds.
 native_script = 
   [  script_pubkey
   // script_all
@@ -474,10 +477,14 @@ script_all = (1, [* native_script])
 
 script_any = (2, [* native_script])
 
-script_n_of_k = (3, n : uint, [* native_script])
+script_n_of_k = (3, n : int64, [* native_script])
 
+; Timelock validity intervals are half-open intervals [a, b).
+; This field specifies the left (included) endpoint a.
 invalid_before = (4, slot)
 
+; Timelock validity intervals are half-open intervals [a, b).
+; This field specifies the right (excluded) endpoint b.
 invalid_hereafter = (5, slot)
 
 bootstrap_witness = 
@@ -488,7 +495,9 @@ bootstrap_witness =
   ]
 
 
-plutus_script = bytes
+; Alonzo introduces Plutus smart contracts.
+; Plutus V1 scripts are opaque bytestrings.
+plutus_v1_script = bytes
 
 ; NEW
 plutus_data = 
@@ -565,7 +574,7 @@ auxiliary_data_array =
 auxiliary_scripts = [* native_script]
 
 auxiliary_data_map = 
-  #6.259({? 0 : metadata, ? 1 : [* native_script], ? 2 : [* plutus_script]})
+  #6.259({? 0 : metadata, ? 1 : [* native_script], ? 2 : [* plutus_v1_script]})
 
 transaction = 
   [transaction_body, transaction_witness_set, bool, auxiliary_data/ nil]

eras/alonzo/impl/testlib/Test/Cardano/Ledger/Alonzo/CDDL.hs

@@ -14,7 +14,7 @@ module Test.Cardano.Ledger.Alonzo.CDDL (
   certificates,
   required_signers,
   network_id,
-  native_script,
+  plutus_v1_script,
   redeemers,
   constr,
   ex_unit_prices,
@@ -252,25 +252,30 @@ transaction_witness_set =
   comment
     [str|
         |NEW:
-        |  3: [* plutus_script ]
+        |  3: [* plutus_v1_script ]
         |  4: [* plutus_data ]
         |  5: redeemers
         |]
     $ "transaction_witness_set"
       =:= mp
         [ opt $ idx 0 ==> arr [0 <+ a vkeywitness]
-        , opt $ idx 1 ==> arr [0 <+ a native_script]
+        , opt $ idx 1 ==> arr [0 <+ a allegra_native_script]
         , opt $ idx 2 ==> arr [0 <+ a bootstrap_witness]
-        , opt $ idx 3 ==> arr [0 <+ a plutus_script]
+        , opt $ idx 3 ==> arr [0 <+ a plutus_v1_script]
         , opt $ idx 4 ==> arr [0 <+ a plutus_data]
         , opt $ idx 5 ==> redeemers
         ]
 
 redeemers :: Rule
 redeemers = "redeemers" =:= arr [0 <+ a redeemer]
 
-plutus_script :: Rule
-plutus_script = "plutus_script" =:= VBytes
+plutus_v1_script :: Rule
+plutus_v1_script =
+  comment
+    [str|Alonzo introduces Plutus smart contracts.
+        |Plutus V1 scripts are opaque bytestrings.
+        |]
+    $ "plutus_v1_script" =:= VBytes
 
 plutus_data :: Rule
 plutus_data =
@@ -360,8 +365,8 @@ auxiliary_data_map =
       259
       ( mp
           [ opt (idx 0 ==> metadata)
-          , opt (idx 1 ==> arr [0 <+ a native_script])
-          , opt (idx 2 ==> arr [0 <+ a plutus_script])
+          , opt (idx 1 ==> arr [0 <+ a allegra_native_script])
+          , opt (idx 2 ==> arr [0 <+ a plutus_v1_script])
           ]
       )
 
@@ -401,28 +406,6 @@ header_body =
         , a (protocol_version @AlonzoEra)
         ]
 
-native_script :: Rule
-native_script =
-  comment
-    [str|Timelock validity intervals are half-open intervals [a, b).
-        |
-        |  invalid_before:
-        |    specifies the left (included) endpoint a.
-        |
-        |  invalid_hereafter:
-        |    specifies the right (excluded) endpoint b.
-        |]
-    $ "native_script"
-      =:= arr [a script_pubkey]
-      / arr [a script_all]
-      / arr [a script_any]
-      / arr [a script_n_of_k]
-      / arr [a invalid_before]
-      / arr [a invalid_hereafter]
-
-script_n_of_k :: Named Group
-script_n_of_k = "script_n_of_k" =:~ grp [3, "n" ==> VUInt, a (arr [0 <+ a native_script])]
-
 positive_interval :: Rule
 positive_interval = "positive_interval" =:= tag 30 (arr [a positive_int, a positive_int])
 

eras/babbage/impl/CHANGELOG.md

@@ -26,6 +26,7 @@
 
 ### `testlib`
 
+* Add `plutus_v2_script` to CDDL exports
 * Hide Shelley CDDL `protocol_version` and re-export a new one for Babbage
 * Use fixed-sized `uint .size 8` for `slot` and `block_number` in CDDL for header
 * Add `BabbageEraImp`