mlabs-haskell · Fiftyw3bs · Dec 28, 2023 · Dec 28, 2023
diff --git a/cardano-simple/README.md b/cardano-simple/README.md
@@ -0,0 +1,51 @@
+Plutus simple model
+====================================================
+
+Unit test library for Plutus with estimation of resource usage.
+
+Library defines simple mock model of Blockchain to unit test plutus contracts
+and estimate usage of resources. What are the benefits for this framework comparing
+to other test frameworks for Plutus? It's:
+
+* easy to use
+* easy to think about
+* it has minimal dependency set. It depends only on plutus and cardano-ledger.
+    Ain't no plutus-apps or cardano-node or ouroboros
+* works for both Plutus V1 and Plutus V2
+* support for Alonzo and Babbage eras
+* blazing fast
+* can estimate usage of resources with real functions used on Cardano node.
+* pure
+* good for unit testing of on-chain code
+* being fast and pure it's also suitable for property based testing
+
+## Quick start guide
+
+See [user guide](https://mlabs-haskell.github.io/plutus-simple-model/) to get started
+
+## How to compile the library
+
+Library is compiled with nix, flakes and cabal. Enter developer nix shell with:
+
+```
+nix develop
+```
+
+Inside the nix shell we can run build and tests over make:
+
+```
+make build
+make test
+```
+
+It calls cabal under the hood.
+
+## How to update docs
+
+Docs are written in [mdbook](https://github.com/rust-lang/mdBook) and reside in the `docs` directory.
+They are auto-deployed with Git actions on push to main. To run docs locally use mdbook:
+
+```
+cd docs
+mdbook serve
+```
diff --git a/cardano-simple/data/alonzo-params.json b/cardano-simple/data/alonzo-params.json
diff --git a/cardano-simple/data/babbage-params.json b/cardano-simple/data/babbage-params.json
diff --git a/cardano-simple/data/protocol-params.json b/cardano-simple/data/protocol-params.json
@@ -0,0 +1,217 @@
+{
+    "txFeePerByte": 44,
+    "minUTxOValue": null,
+    "stakePoolDeposit": 0,
+    "utxoCostPerWord": 34482,
+    "decentralization": 0.7,
+    "poolRetireMaxEpoch": 18,
+    "extraPraosEntropy": null,
+    "collateralPercentage": 150,
+    "stakePoolTargetNum": 100,
+    "maxBlockBodySize": 65536,
+    "maxTxSize": 20000,
+    "treasuryCut": 0,
+    "minPoolCost": 0,
+    "maxCollateralInputs": 3,
+    "maxValueSize": 5000,
+    "maxBlockExecutionUnits": {
+        "memory": 50000000,
+        "steps": 40000000000
+    },
+    "maxBlockHeaderSize": 1100,
+    "costModels": {
+        "PlutusScriptV1": {
+            "addInteger-cpu-arguments-intercept": 205665,
+            "addInteger-cpu-arguments-slope": 812,
+            "addInteger-memory-arguments-intercept": 1,
+            "addInteger-memory-arguments-slope": 1,
+            "appendByteString-cpu-arguments-intercept": 1000,
+            "appendByteString-cpu-arguments-slope": 571,
+            "appendByteString-memory-arguments-intercept": 0,
+            "appendByteString-memory-arguments-slope": 1,
+            "appendString-cpu-arguments-intercept": 1000,
+            "appendString-cpu-arguments-slope": 24177,
+            "appendString-memory-arguments-intercept": 4,
+            "appendString-memory-arguments-slope": 1,
+            "bData-cpu-arguments": 1000,
+            "bData-memory-arguments": 32,
+            "blake2b_256-cpu-arguments-intercept": 117366,
+            "blake2b_256-cpu-arguments-slope": 10475,
+            "blake2b_256-memory-arguments": 4,
+            "cekApplyCost-exBudgetCPU": 23000,
+            "cekApplyCost-exBudgetMemory": 100,
+            "cekBuiltinCost-exBudgetCPU": 23000,
+            "cekBuiltinCost-exBudgetMemory": 100,
+            "cekConstCost-exBudgetCPU": 23000,
+            "cekConstCost-exBudgetMemory": 100,
+            "cekDelayCost-exBudgetCPU": 23000,
+            "cekDelayCost-exBudgetMemory": 100,
+            "cekForceCost-exBudgetCPU": 23000,
+            "cekForceCost-exBudgetMemory": 100,
+            "cekLamCost-exBudgetCPU": 23000,
+            "cekLamCost-exBudgetMemory": 100,
+            "cekStartupCost-exBudgetCPU": 100,
+            "cekStartupCost-exBudgetMemory": 100,
+            "cekVarCost-exBudgetCPU": 23000,
+            "cekVarCost-exBudgetMemory": 100,
+            "chooseData-cpu-arguments": 19537,
+            "chooseData-memory-arguments": 32,
+            "chooseList-cpu-arguments": 175354,
+            "chooseList-memory-arguments": 32,
+            "chooseUnit-cpu-arguments": 46417,
+            "chooseUnit-memory-arguments": 4,
+            "consByteString-cpu-arguments-intercept": 221973,
+            "consByteString-cpu-arguments-slope": 511,
+            "consByteString-memory-arguments-intercept": 0,
+            "consByteString-memory-arguments-slope": 1,
+            "constrData-cpu-arguments": 89141,
+            "constrData-memory-arguments": 32,
+            "decodeUtf8-cpu-arguments-intercept": 497525,
+            "decodeUtf8-cpu-arguments-slope": 14068,
+            "decodeUtf8-memory-arguments-intercept": 4,
+            "decodeUtf8-memory-arguments-slope": 2,
+            "divideInteger-cpu-arguments-constant": 196500,
+            "divideInteger-cpu-arguments-model-arguments-intercept": 453240,
+            "divideInteger-cpu-arguments-model-arguments-slope": 220,
+            "divideInteger-memory-arguments-intercept": 0,
+            "divideInteger-memory-arguments-minimum": 1,
+            "divideInteger-memory-arguments-slope": 1,
+            "encodeUtf8-cpu-arguments-intercept": 1000,
+            "encodeUtf8-cpu-arguments-slope": 28662,
+            "encodeUtf8-memory-arguments-intercept": 4,
+            "encodeUtf8-memory-arguments-slope": 2,
+            "equalsByteString-cpu-arguments-constant": 245000,
+            "equalsByteString-cpu-arguments-intercept": 216773,
+            "equalsByteString-cpu-arguments-slope": 62,
+            "equalsByteString-memory-arguments": 1,
+            "equalsData-cpu-arguments-intercept": 1060367,
+            "equalsData-cpu-arguments-slope": 12586,
+            "equalsData-memory-arguments": 1,
+            "equalsInteger-cpu-arguments-intercept": 208512,
+            "equalsInteger-cpu-arguments-slope": 421,
+            "equalsInteger-memory-arguments": 1,
+            "equalsString-cpu-arguments-constant": 187000,
+            "equalsString-cpu-arguments-intercept": 1000,
+            "equalsString-cpu-arguments-slope": 52998,
+            "equalsString-memory-arguments": 1,
+            "fstPair-cpu-arguments": 80436,
+            "fstPair-memory-arguments": 32,
+            "headList-cpu-arguments": 43249,
+            "headList-memory-arguments": 32,
+            "iData-cpu-arguments": 1000,
+            "iData-memory-arguments": 32,
+            "ifThenElse-cpu-arguments": 80556,
+            "ifThenElse-memory-arguments": 1,
+            "indexByteString-cpu-arguments": 57667,
+            "indexByteString-memory-arguments": 4,
+            "lengthOfByteString-cpu-arguments": 1000,
+            "lengthOfByteString-memory-arguments": 10,
+            "lessThanByteString-cpu-arguments-intercept": 197145,
+            "lessThanByteString-cpu-arguments-slope": 156,
+            "lessThanByteString-memory-arguments": 1,
+            "lessThanEqualsByteString-cpu-arguments-intercept": 197145,
+            "lessThanEqualsByteString-cpu-arguments-slope": 156,
+            "lessThanEqualsByteString-memory-arguments": 1,
+            "lessThanEqualsInteger-cpu-arguments-intercept": 204924,
+            "lessThanEqualsInteger-cpu-arguments-slope": 473,
+            "lessThanEqualsInteger-memory-arguments": 1,
+            "lessThanInteger-cpu-arguments-intercept": 208896,
+            "lessThanInteger-cpu-arguments-slope": 511,
+            "lessThanInteger-memory-arguments": 1,
+            "listData-cpu-arguments": 52467,
+            "listData-memory-arguments": 32,
+            "mapData-cpu-arguments": 64832,
+            "mapData-memory-arguments": 32,
+            "mkCons-cpu-arguments": 65493,
+            "mkCons-memory-arguments": 32,
+            "mkNilData-cpu-arguments": 22558,
+            "mkNilData-memory-arguments": 32,
+            "mkNilPairData-cpu-arguments": 16563,
+            "mkNilPairData-memory-arguments": 32,
+            "mkPairData-cpu-arguments": 76511,
+            "mkPairData-memory-arguments": 32,
+            "modInteger-cpu-arguments-constant": 196500,
+            "modInteger-cpu-arguments-model-arguments-intercept": 453240,
+            "modInteger-cpu-arguments-model-arguments-slope": 220,
+            "modInteger-memory-arguments-intercept": 0,
+            "modInteger-memory-arguments-minimum": 1,
+            "modInteger-memory-arguments-slope": 1,
+            "multiplyInteger-cpu-arguments-intercept": 69522,
+            "multiplyInteger-cpu-arguments-slope": 11687,
+            "multiplyInteger-memory-arguments-intercept": 0,
+            "multiplyInteger-memory-arguments-slope": 1,
+            "nullList-cpu-arguments": 60091,
+            "nullList-memory-arguments": 32,
+            "quotientInteger-cpu-arguments-constant": 196500,
+            "quotientInteger-cpu-arguments-model-arguments-intercept": 453240,
+            "quotientInteger-cpu-arguments-model-arguments-slope": 220,
+            "quotientInteger-memory-arguments-intercept": 0,
+            "quotientInteger-memory-arguments-minimum": 1,
+            "quotientInteger-memory-arguments-slope": 1,
+            "remainderInteger-cpu-arguments-constant": 196500,
+            "remainderInteger-cpu-arguments-model-arguments-intercept": 453240,
+            "remainderInteger-cpu-arguments-model-arguments-slope": 220,
+            "remainderInteger-memory-arguments-intercept": 0,
+            "remainderInteger-memory-arguments-minimum": 1,
+            "remainderInteger-memory-arguments-slope": 1,
+            "serialiseData-cpu-arguments-intercept": 1159724,
+            "serialiseData-cpu-arguments-slope": 392670,
+            "serialiseData-memory-arguments-intercept": 0,
+            "serialiseData-memory-arguments-slope": 2,
+            "sha2_256-cpu-arguments-intercept": 806990,
+            "sha2_256-cpu-arguments-slope": 30482,
+            "sha2_256-memory-arguments": 4,
+            "sha3_256-cpu-arguments-intercept": 1927926,
+            "sha3_256-cpu-arguments-slope": 82523,
+            "sha3_256-memory-arguments": 4,
+            "sliceByteString-cpu-arguments-intercept": 265318,
+            "sliceByteString-cpu-arguments-slope": 0,
+            "sliceByteString-memory-arguments-intercept": 4,
+            "sliceByteString-memory-arguments-slope": 0,
+            "sndPair-cpu-arguments": 85931,
+            "sndPair-memory-arguments": 32,
+            "subtractInteger-cpu-arguments-intercept": 205665,
+            "subtractInteger-cpu-arguments-slope": 812,
+            "subtractInteger-memory-arguments-intercept": 1,
+            "subtractInteger-memory-arguments-slope": 1,
+            "tailList-cpu-arguments": 41182,
+            "tailList-memory-arguments": 32,
+            "trace-cpu-arguments": 212342,
+            "trace-memory-arguments": 32,
+            "unBData-cpu-arguments": 31220,
+            "unBData-memory-arguments": 32,
+            "unConstrData-cpu-arguments": 32696,
+            "unConstrData-memory-arguments": 32,
+            "unIData-cpu-arguments": 43357,
+            "unIData-memory-arguments": 32,
+            "unListData-cpu-arguments": 32247,
+            "unListData-memory-arguments": 32,
+            "unMapData-cpu-arguments": 38314,
+            "unMapData-memory-arguments": 32,
+            "verifyEcdsaSecp256k1Signature-cpu-arguments": 35892428,
+            "verifyEcdsaSecp256k1Signature-memory-arguments": 10,
+            "verifyEd25519Signature-cpu-arguments-intercept": 9462713,
+            "verifyEd25519Signature-cpu-arguments-slope": 1021,
+            "verifyEd25519Signature-memory-arguments": 10,
+            "verifySchnorrSecp256k1Signature-cpu-arguments-intercept": 38887044,
+            "verifySchnorrSecp256k1Signature-cpu-arguments-slope": 32947,
+            "verifySchnorrSecp256k1Signature-memory-arguments": 10
+        }
+    },
+    "maxTxExecutionUnits": {
+        "memory": 30000000,
+        "steps": 10000000000
+    },
+    "protocolVersion": {
+        "minor": 0,
+        "major": 6
+    },
+    "txFeeFixed": 155381,
+    "stakeAddressDeposit": 0,
+    "monetaryExpansion": 0,
+    "poolPledgeInfluence": 0,
+    "executionUnitPrices": {
+        "priceSteps": 7.21e-5,
+        "priceMemory": 5.77e-2
+    }
+}
diff --git a/psm/README.md b/psm/README.md
@@ -0,0 +1,51 @@
+Plutus simple model
+====================================================
+
+Unit test library for Plutus with estimation of resource usage.
+
+Library defines simple mock model of Blockchain to unit test plutus contracts
+and estimate usage of resources. What are the benefits for this framework comparing
+to other test frameworks for Plutus? It's:
+
+* easy to use
+* easy to think about
+* it has minimal dependency set. It depends only on plutus and cardano-ledger.
+    Ain't no plutus-apps or cardano-node or ouroboros
+* works for both Plutus V1 and Plutus V2
+* support for Alonzo and Babbage eras
+* blazing fast
+* can estimate usage of resources with real functions used on Cardano node.
+* pure
+* good for unit testing of on-chain code
+* being fast and pure it's also suitable for property based testing
+
+## Quick start guide
+
+See [user guide](https://mlabs-haskell.github.io/plutus-simple-model/) to get started
+
+## How to compile the library
+
+Library is compiled with nix, flakes and cabal. Enter developer nix shell with:
+
+```
+nix develop
+```
+
+Inside the nix shell we can run build and tests over make:
+
+```
+make build
+make test
+```
+
+It calls cabal under the hood.
+
+## How to update docs
+
+Docs are written in [mdbook](https://github.com/rust-lang/mdBook) and reside in the `docs` directory.
+They are auto-deployed with Git actions on push to main. To run docs locally use mdbook:
+
+```
+cd docs
+mdbook serve
+```