Merge branch 'master' into koz/secp256k1

Author: kozross

README.adoc

@@ -64,6 +64,44 @@ The main documentation is located https://plutus.readthedocs.io/en/latest/[here]
 - https://hydra.iohk.io/job/Cardano/plutus/linux.docs.papers.utxoma/latest/download-by-type/doc-pdf/utxoma[UTXOma: UTXO with Multi-Asset Support]: a full presentation of the multi-asset ledger extension (https://doi.org/10.1007/978-3-030-61467-6_8[published version]).
 - https://hydra.iohk.io/job/Cardano/plutus/linux.docs.papers.eutxoma/latest/download-by-type/doc-pdf/eutxoma[Native Custom Tokens in the Extended UTXO Model]: a discussion of the interaction of the multi-asset support with EUTXO (https://doi.org/10.1007/978-3-030-61467-6_7[published version]).
 
+== Versioning and releases
+
+=== Versioning
+
+The core `plutus` packages are versioned as follows:
+
+* Package versioning follows the https://pvp.haskell.org/[PVP] on a best-effort basis (i.e. we will generally try to but we won't guarantee it).
+** The first-major-version component indicates the "era" which for our purposes means which major version of the *Cardano node* is being targeted.
+** The second-major-version component is used for releases which are major versions according to the PVP, but which are still compatible with the current "era".
+** The minor-version and below are used as normal.
+* Packages which are used downstream should all have the same version.
+* Other packages which are not used downstream (e.g. `plutus-benchmark`) can remain unversioned.
+
+In principle we could just have a single major version, but using two makes it easier to avoid mistakes.
+
+=== Branching and tagging
+
+The following branching and tagging rules are followed:
+
+* Version `X` is tagged as `vX`.
+* `master` is always targeting the next first-major-version.
+* First-major-version releases also have a release branch, `release/X`.
+** Changes will be backported from master to the release branch
+** Subsequent lesser releases will be made from that branch but do not create new branches.
+
+=== Version ranges
+
+Packages which depend on `plutus` packages should use version ranges to control which version of those packages they build against.
+
+* Packages in `plutus` which are used downstream should pin the major-version of each other (e.g. `plutus-tx-1.0.1` should depend on `plutus-core ^>= 1.0`).
+* Downstream packages should pin at least the first-major-version of `plutus` packages.
+** Upgrading to a new second-major-version should always be safe, with at most code breakage (following the PVP). Users may of course want to pin this version as well to avoid such breakage.
+* Downstream packages pulling in `plutus` packages via `source-repository-package` stanzas should always take tagged commits, or potentially commits from a release branch.
+
+=== Releases
+
+Currently there is no release process beyond bumping the package versions and making a tag/branch as appropriate.
+
 == Working with the project
 
 === How to submit an issue

doc/reference/builtin-parameters.csv

@@ -35,7 +35,7 @@ decodeUtf8,decodeUtf8-memory-arguments-slope,Linear model coefficient for the me
 divideInteger,divideInteger-cpu-arguments-constant,Constant CPU cost (argument sizes above diagonal)
 divideInteger,divideInteger-cpu-arguments-model-arguments-intercept,Linear model intercept for the CPU calculation (argument sizes on or below diagonal)
 divideInteger,divideInteger-cpu-arguments-model-arguments-slope,Linear model coefficient for the CPU calculation (argument sizes on or below diagonal)
-divideInteger,divideInteger-memory-arguments-intercept,Linear model intercept for the memory calculation (argument sizes on or below diagonal) 
+divideInteger,divideInteger-memory-arguments-intercept,Linear model intercept for the memory calculation (argument sizes on or below diagonal)
 divideInteger,divideInteger-memory-arguments-minimum,Constant memory cost (argument sizes above diagonal)
 divideInteger,divideInteger-memory-arguments-slope,Linear model coefficient for the memory calculation (argument sizes on or below diagonal)
 encodeUtf8,encodeUtf8-cpu-arguments-intercept,Linear model intercept for the CPU calculation below diagonal
@@ -98,7 +98,7 @@ modInteger,modInteger-cpu-arguments-model-arguments-slope,Linear model coefficie
 modInteger,modInteger-memory-arguments-intercept,Linear model intercept for the memory calculation
 modInteger,modInteger-memory-arguments-minimum,Constant memory cost (argument sizes above diagonal)
 modInteger,modInteger-memory-arguments-slope,Linear model coefficient for the memory calculation (argument sizes on or below diagonal)
-multiplyInteger,multiplyInteger-cpu-arguments-intercept,Linear model intercept for the CPU calculation 
+multiplyInteger,multiplyInteger-cpu-arguments-intercept,Linear model intercept for the CPU calculation
 multiplyInteger,multiplyInteger-cpu-arguments-slope,Linear model coefficient for the CPU calculation
 multiplyInteger,multiplyInteger-memory-arguments-intercept,Linear model intercept for the memory calculation
 multiplyInteger,multiplyInteger-memory-arguments-slope,Linear model coefficient for the memory calculation
@@ -116,6 +116,10 @@ remainderInteger,remainderInteger-cpu-arguments-model-arguments-slope,Linear mod
 remainderInteger,remainderInteger-memory-arguments-intercept,Linear model intercept for the memory calculation (argument sizes on or below diagonal)
 remainderInteger,remainderInteger-memory-arguments-minimum,Constant memory cost (argument sizes above diagonal)
 remainderInteger,remainderInteger-memory-arguments-slope,Linear model coefficient for the memory calculation (argument sizes on or below diagonal)
+serialiseData,serialiseData-cpu-arguments-intercept,TODO
+serialiseData,serialiseData-cpu-arguments-slope,TODO
+serialiseData,serialiseData-memory-arguments-intercept,TODO
+serialiseData,serialiseData-memory-arguments-slope,TODO
 sha2_256,sha2_256-cpu-arguments-intercept,Linear model intercept for the CPU calculation
 sha2_256,sha2_256-cpu-arguments-slope,Linear model coefficient for the CPU calculation
 sha2_256,sha2_256-memory-arguments,Constant memory cost

plutus-core/cost-model/budgeting-bench/Benchmarks/Data.hs

@@ -126,6 +126,10 @@ benchEqualsData =
         where args1 = dataSampleForEq -- 400 elements: should take about 35 minutes to benchmark
               args2 = fmap copyData args1
 
+benchSerialiseData :: Benchmark
+benchSerialiseData =
+    createOneTermBuiltinBench SerialiseData [] args
+        where args = dataSampleForEq -- FIXME: is this a good sample for serialization?
 
 makeBenchmarks :: StdGen -> [Benchmark]
 makeBenchmarks gen =
@@ -141,4 +145,5 @@ makeBenchmarks gen =
     , benchUnIData
     , benchUnBData
     , benchEqualsData
+    , benchSerialiseData
     ]

plutus-core/cost-model/create-cost-model/CostModelCreation.hs

@@ -95,6 +95,7 @@ builtinCostModelNames = BuiltinCostModelBase
   , paramMkPairData               = "mkPairDataModel"
   , paramMkNilData                = "mkNilDataModel"
   , paramMkNilPairData            = "mkNilPairDataModel"
+  , paramSerialiseData            = "serialiseDataModel"
   }
 
 
@@ -175,6 +176,7 @@ createBuiltinCostModel =
     paramUnIData                  <- getParams unIData        paramUnIData
     paramUnBData                  <- getParams unBData        paramUnBData
     paramEqualsData               <- getParams equalsData     paramEqualsData
+    paramSerialiseData            <- getParams serialiseData  paramSerialiseData
     -- Misc constructors
     paramMkPairData               <- getParams mkPairData     paramMkPairData
     paramMkNilData                <- getParams mkNilData      paramMkNilData
@@ -676,6 +678,14 @@ equalsData cpuModelR = do
      worst case it may have to examine almost all of the smaller argument before
      realising that the two arguments are different. -}
 
+serialiseData :: MonadR m => (SomeSEXP (Region m)) -> m (CostingFun ModelOneArgument)
+serialiseData cpuModelR = do
+  -- FIXME: add cpumodel for serialisedata
+  cpuModel <- ModelOneArgumentLinearCost <$> readModelLinearInX cpuModelR
+  -- FIXME: add memmodel for serialisedata
+  let memModel = ModelOneArgumentLinearCost $ ModelLinearSize 0 0
+  pure $ CostingFun cpuModel memModel
+
 ---------------- Misc constructors ----------------
 
 mkPairData :: MonadR m => (SomeSEXP (Region m)) -> m (CostingFun ModelTwoArguments)

plutus-core/cost-model/data/builtinCostModel.json

@@ -389,6 +389,22 @@
             "type": "constant_cost"
         }
     },
+    "serialiseData": {
+        "memory": {
+            "arguments": {
+                "slope": 0,
+                "intercept": 0
+            },
+            "type": "linear_cost"
+        },
+        "cpu": {
+            "arguments": {
+                "slope": 0,
+                "intercept": 0
+            },
+            "type": "linear_cost"
+        }
+    },
     "addInteger": {
         "memory": {
             "arguments": {

plutus-core/cost-model/data/models.R

@@ -77,6 +77,7 @@ arity <- function(name) {
         "AppendString" = 2,
         "EqualsString" = 2,
         "EncodeUtf8" = 1,
+        "SerialiseData" = 1,
         "DecodeUtf8" = 1,
         "IfThenElse" = 3,
         "ChooseUnit" = 2,
@@ -550,6 +551,12 @@ modelFun <- function(path) {
         adjustModel(m2,fname)
     }
 
+    serialiseDataModel <- {
+        fname <- "SerialiseData"
+        #FIXME
+    }
+
+
     mkPairDataModel     <- constantModel ("MkPairData")
     mkNilDataModel      <- constantModel ("MkNilData")
     mkNilPairDataModel  <- constantModel ("MkNilPairData")
@@ -605,6 +612,7 @@ modelFun <- function(path) {
         equalsDataModel               = equalsDataModel,
         mkPairDataModel               = mkPairDataModel,
         mkNilDataModel                = mkNilDataModel,
-        mkNilPairDataModel            = mkNilPairDataModel
+        mkNilPairDataModel            = mkNilPairDataModel,
+        serialiseDataModel            = serialiseDataModel
     )
 }

plutus-core/cost-model/test/TestCostModels.hs

@@ -345,6 +345,7 @@ main =
                     , $(genTest 1 "unIData")
                     , $(genTest 1 "unBData")
                     , $(genTest 2 "equalsData") Everywhere
+                    , $(genTest 1 "serialiseData")
 
                     -- Misc constructors
                     , $(genTest 2 "mkPairData") Everywhere

plutus-core/plutus-core/src/PlutusCore/Default/Builtins.hs

@@ -23,9 +23,11 @@ import PlutusCore.Evaluation.Machine.ExMemory
 import PlutusCore.Evaluation.Result
 import PlutusCore.Pretty
 
+import Codec.Serialise (serialise)
 import Crypto (verifyEcdsaSecp256k1Signature, verifySchnorrSecp256k1Signature, verifySignature)
 import Data.ByteString qualified as BS
 import Data.ByteString.Hash qualified as Hash
+import Data.ByteString.Lazy qualified as BS (toStrict)
 import Data.Char
 import Data.Ix
 import Data.Text (Text)
@@ -104,6 +106,7 @@ data DefaultFun
     | UnIData
     | UnBData
     | EqualsData
+    | SerialiseData
     -- Misc constructors
     -- Constructors that we need for constructing e.g. Data. Polymorphic builtin
     -- constructors are often problematic (See note [Representable built-in
@@ -982,6 +985,10 @@ instance uni ~ DefaultUni => ToBuiltinMeaning uni DefaultFun where
         makeBuiltinMeaning
             ((==) @Data)
             (runCostingFunTwoArguments . paramEqualsData)
+    toBuiltinMeaning SerialiseData =
+        makeBuiltinMeaning
+            (BS.toStrict . serialise @Data)
+            (runCostingFunOneArgument . paramSerialiseData)
     -- Misc constructors
     toBuiltinMeaning MkPairData =
         makeBuiltinMeaning
@@ -1073,10 +1080,10 @@ instance Flat DefaultFun where
               UnIData                         -> 45
               UnBData                         -> 46
               EqualsData                      -> 47
-
               MkPairData                      -> 48
               MkNilData                       -> 49
               MkNilPairData                   -> 50
+              SerialiseData                   -> 51
 
     decode = go =<< decodeBuiltin
         where go 0  = pure AddInteger
@@ -1130,6 +1137,7 @@ instance Flat DefaultFun where
               go 48 = pure MkPairData
               go 49 = pure MkNilData
               go 50 = pure MkNilPairData
+              go 51 = pure SerialiseData
               go 52 = pure VerifyEcdsaSecp256k1Signature
               go 53 = pure VerifySchnorrSecp256k1Signature
               go t  = fail $ "Failed to decode builtin tag, got: " ++ show t

plutus-core/plutus-core/src/PlutusCore/Evaluation/Machine/BuiltinCostModel.hs

@@ -153,6 +153,7 @@ data BuiltinCostModelBase f =
     , paramMkPairData               :: f ModelTwoArguments
     , paramMkNilData                :: f ModelOneArgument
     , paramMkNilPairData            :: f ModelOneArgument
+    , paramSerialiseData            :: f ModelOneArgument
     }
     deriving stock (Generic)
     deriving anyclass (FunctorB, TraversableB, ConstraintsB)

plutus-core/plutus-core/src/PlutusCore/Evaluation/Machine/ExBudgetingDefaults.hs

@@ -163,4 +163,5 @@ unitCostBuiltinCostModel = BuiltinCostModelBase
     , paramMkPairData               = unitCostTwoArguments
     , paramMkNilData                = unitCostOneArgument
     , paramMkNilPairData            = unitCostOneArgument
+    , paramSerialiseData            = unitCostOneArgument
     }