Merge pull request #98 from mlabs-haskell/alexey/test-oura-filters

L1 chain indexing

Author: euonymos

.ghcid

@@ -1 +1 @@
---command="cabal repl test-suite:cem-sdk-test" -W -T ":main"
+--command="cabal repl test-suite:cem-script-test" -W -T ":main"

.gitignore

@@ -27,3 +27,4 @@ haddocks
 # Functions changed by runing local testnet
 devnet/db
 devnet/genesis-*.json
+test.log

Makefile

@@ -0,0 +1,13 @@
+.PHONY: run-oura-daemon
+
+clear-sockets:
+	@rm ./oura-daemon-cursor || true
+	@rm ./oura-listening.socket || true
+	@rm ./own.socket || true
+
+run-oura-daemon:
+	@clear-sockets || true
+	@oura daemon --config ./test/daemon.toml
+
+format:
+	fourmolu --mode inplace $$(git ls-files '*.hs')

cabal.project

@@ -22,7 +22,7 @@ source-repository-package
   tag: d5b0e7ce07258482d53704ce19383013b1fa6610
   --sha256: 6+Os/mQDzBOU+TkTD+n/T1MFcI+Mn0/tcBMJhLRfqyA=
 
--- FIXME: Cannot use new commit, because it requires `plutus-ledger-api==1.29`
+-- Cannot use new commit, because it requires `plutus-ledger-api==1.29`
 source-repository-package
   type: git
   location: https://github.com/Plutonomicon/plutarch-plutus

cem-script.cabal

@@ -1,10 +1,10 @@
 cabal-version: 3.8
 name:          cem-script
 version:       0.1.0
-synopsis:      Cardano DApp SDK
-homepage:      https://github.com/cem-script
+synopsis:      CEM Script - a Cardano dApp SDK
+homepage:      https://github.com/mlabs-haskell/cem-script
 author:        MLabs
-maintainer:    gregory@mlabs.city
+maintainer:    ilia@mlabs.city
 data-files:    README.md
 tested-with:   GHC ==9.6.3
 
@@ -15,9 +15,11 @@ flag dev
   default:     True
   manual:      False
 
-common common-lang
-  -- Options from MLabs styleguide
+flag force-recomp
+  description: Compile with -fforce-recomp and -Wunused-packages
+  default:     False
 
+common common-lang
   ghc-options:
     -Wall -Wcompat -Wincomplete-record-updates
     -Wincomplete-uni-patterns -Wredundant-constraints
@@ -26,9 +28,16 @@ common common-lang
   if !flag(dev)
     ghc-options: -Werror
 
+  if flag(dev)
+    default-extensions: PartialTypeSignatures
+
+  if flag(force-recomp)
+    ghc-options: -fforce-recomp -Wunused-packages
+
   build-depends:
     , base
     , containers
+    , extra
     , mtl
     , transformers
 
@@ -54,9 +63,6 @@ common common-lang
     UndecidableInstances
     ViewPatterns
 
-  if flag(dev)
-    default-extensions: PartialTypeSignatures
-
   default-language:   GHC2021
 
 common common-onchain
@@ -75,9 +81,6 @@ common common-onchain
   if !flag(dev)
     ghc-options: -fplugin-opt PlutusTx.Plugin:defer-errors
 
-  -- Options for Plutus Tx compilations
-  -- (some are enabled additionaly in individual modules)
-
   ghc-options:
     -fplugin-opt PlutusTx.Plugin:target-version=1.0.0 -fobject-code
     -fno-ignore-interface-pragmas -fno-omit-interface-pragmas
@@ -116,9 +119,9 @@ common common-executable
 
 library data-spine
   import:          common-lang
-  hs-source-dirs:  src-lib/data-spine
+  hs-source-dirs:  lib/data-spine
 
-  -- FIXME: was not meant to be dependent on Plutus...
+  -- TODO: Originally was not meant to be dependent on Plutus
   build-depends:
     , plutus-tx
     , singletons
@@ -131,12 +134,11 @@ library cardano-extras
     common-offchain,
     common-onchain
 
-  hs-source-dirs:  src-lib/cardano-extras
+  hs-source-dirs:  lib/cardano-extras
   build-depends:   template-haskell
   exposed-modules:
     Cardano.Extras
     Plutarch.Extras
-    Plutus.Deriving
     Plutus.Extras
 
 library
@@ -147,55 +149,100 @@ library
   hs-source-dirs:  src/
   exposed-modules:
     Cardano.CEM
+    Cardano.CEM.Indexing
+    Cardano.CEM.Testing.StateMachine
+
+  other-modules:
+    Cardano.CEM.Address
+    Cardano.CEM.Compile
     Cardano.CEM.Documentation
     Cardano.CEM.DSL
-    Cardano.CEM.Examples.Auction
-    Cardano.CEM.Examples.Compilation
-    Cardano.CEM.Examples.Voting
+    Cardano.CEM.Indexing.Event
+    Cardano.CEM.Indexing.Oura
+    Cardano.CEM.Indexing.Tx
     Cardano.CEM.Monads
     Cardano.CEM.Monads.CLB
-    Cardano.CEM.Monads.L1
+    Cardano.CEM.Monads.L1Commons
     Cardano.CEM.OffChain
     Cardano.CEM.OnChain
-    Cardano.CEM.Testing.StateMachine
+    Cardano.CEM.Smart
     Cardano.CEM.TH
 
-  other-modules:   Cardano.CEM.Monads.L1Commons
   build-depends:
+    , base16
+    , base64
     , cem-script:cardano-extras
     , cem-script:data-spine
     , clb
     , dependent-map
+    , lens
     , ouroboros-consensus
     , QuickCheck
     , quickcheck-dynamic
+    , safe
     , singletons-th
+    , toml-parser
+    , vector
+
+library cem-script-example
+  import:
+    , common-lang
+    , common-onchain
+
+  hs-source-dirs:  example
+  build-depends:   cem-script
+  exposed-modules:
+    CEM.Example.Auction
+    CEM.Example.Compiled
+    CEM.Example.Voting
 
-test-suite cem-sdk-test
+test-suite cem-script-test
   import:
     common-onchain,
     common-offchain,
 
   type:           exitcode-stdio-1.0
-  ghc-options:    -Wno-missing-signatures -Wno-incomplete-uni-patterns
+  ghc-options:
+    -threaded -Wno-missing-signatures -Wno-incomplete-uni-patterns
+
   build-depends:
+    , aeson
+    , async
+    , base16
+    , base32
+    , base64
+    , cardano-api
+    , cardano-ledger-core
     , cem-script
     , cem-script:cardano-extras
+    , cem-script:cem-script-example
     , cem-script:data-spine
     , clb
     , dependent-map
+    , directory
     , hspec
+    , hspec-core
+    , lens
+    , network
+    , process
     , QuickCheck
     , quickcheck-dynamic
     , random
+    , safe
+    , toml-parser
+    , vector
 
   hs-source-dirs: test/
   other-modules:
-    Auction
-    Dynamic
-    OffChain
-    TestNFT
-    Utils
-    Voting
+    CEM.Test.Auction
+    CEM.Test.Dynamic
+    CEM.Test.OffChain
+    CEM.Test.Oura.Communication
+    CEM.Test.OuraFilters.Auction
+    CEM.Test.OuraFilters.Mock
+    CEM.Test.OuraFilters.Simple
+    CEM.Test.TestNFT
+    CEM.Test.Utils
+    CEM.Test.Voting
 
   main-is:        Main.hs

docs/arch_principles.md

@@ -2,25 +2,25 @@
 
 ## Principles
 
-* Generic compilation across: on-chain code,
-offchain Tx construction and indexing backend
+* Generic compilation across:
+    * on-chain code
+    * offchain Tx construction
+    * indexing backend
 * Simple normalization and SMT conversion for:
     * Equivalence checking
     * Bi-simulation checking
-* Constraints determine TxIn/Outs up to UTxO coin-selection
-(we call it almost-determinacy)
+* Constraints determine TxIn/Outs up to UTxO coin-selection (we call it almost-determinacy)
 * Datum properties encoded as class types
 * Common on-chain optimizations are performed if possible
-    * Constraints normalization,  and CSE
+    * Constraints normalization, and CSE
     * Best error short-cutting
     * Common security problems prevention
 
 ## Potential obstacles
 
 * Ease and optimality of backend compilation
 * Robustness of SMT conversion and overall normalization
-* Possibility for parsing and correct offchain usage
-of almost-determinacy
+* Possibility for parsing and correct offchain usage of almost-determinacy
 * Having enough information for Tx submit retrying strategies
 * Design for using custom Datum properties is not obvious
 
@@ -32,9 +32,8 @@ all their principles and obstacles are affecting CEM as well.
 ## Principles
 
 * State-machine is deterministic modulo coin-change
-    * Transaction can always be parsed back into SM transitions
-    * Potential non-deterministic on-chain optimizations
-    should not affect this principle.
+* Transaction can always be parsed back into SM transitions
+* Potential non-deterministic on-chain optimizations should not affect this principle.
 
 ## Potential obstacles
 

docs/catalyst_milestone_reports.md

@@ -1,37 +1,14 @@
-# Milestone 3
+# Milestone 5
 
 ## Summary
 
-Changes:
-
-* Running in emulated environment by CLB
-  ([source](https://github.com/mlabs-haskell/cem-script/blob/master/src/Cardano/CEM/Monads/CLB.hs), usage examples are all unit tests)
-* Running Quickcheck Dynamic tests, including mutation support
-  ([source](https://github.com/mlabs-haskell/cem-script/blob/master/src/Cardano/CEM/Testing/StateMachine.hs),
-  [usage example](https://github.com/mlabs-haskell/cem-script/blob/master/test/Dynamic.hs),
-  [PR](https://github.com/mlabs-haskell/cem-script/pull/75) and [PR2](https://github.com/mlabs-haskell/cem-script/pull/89))
-* Rendering CEMScript state graphs
-  ([source](https://github.com/mlabs-haskell/cem-script/blob/master/src/Cardano/CEM/Documentation.hs), rendered example below,
-  [PR](https://github.com/mlabs-haskell/cem-script/pull/33))
-
-## State graph examples
-
-![](./auction-state-graph.svg)
-
-
-Source code:
-
-```
-digraph Creator {
-rankdir=LR;
-node [shape="dot",fontsize=14,fixedsize=true,width=1.5];
-edge [fontsize=11];"Void In" [color="orange"];"Void Out" [color="orange"];"Void In" -> NotStarted [label="Create (stage Open)"];
-NotStarted -> CurrentBid [label="Start (stage Open)"];
-CurrentBid -> CurrentBid [label="MakeBid (stage Open)"];
-CurrentBid -> Winner [label="Close (stage Closed)"];
-Winner -> "Void Out" [label="Buyout (stage Closed)"];
-}
-```
+* L1 indexing:
+  * [Basic indexing support PR #98](https://github.com/mlabs-haskell/cem-script/pull/98)
+  * [Oura config generation PR #100](https://github.com/mlabs-haskell/cem-script/pull/100)
+  * [Source](https://github.com/mlabs-haskell/cem-script/blob/master/src/Cardano/CEM/Indexing.hs)
+  * [Tests for Auction example](https://github.com/mlabs-haskell/cem-script/blob/master/test/OuraFilter/Auction.hs)
+* Final code clean-up
+* Final tutorial and docs
 
 ## Clarifications on M3 Deliverables
 
@@ -163,3 +140,38 @@ Voting Plutarch backend:
     )
   ]
 ```
+
+# Milestone 3
+
+## Summary
+
+Changes:
+
+* Running in emulated environment by CLB
+  ([source](https://github.com/mlabs-haskell/cem-script/blob/master/src/Cardano/CEM/Monads/CLB.hs), usage examples are all unit tests)
+* Running Quickcheck Dynamic tests, including mutation support
+  ([source](https://github.com/mlabs-haskell/cem-script/blob/master/src/Cardano/CEM/Testing/StateMachine.hs),
+  [usage example](https://github.com/mlabs-haskell/cem-script/blob/master/test/Dynamic.hs),
+  [PR](https://github.com/mlabs-haskell/cem-script/pull/75) and [PR2](https://github.com/mlabs-haskell/cem-script/pull/89))
+* Rendering CEMScript state graphs
+  ([source](https://github.com/mlabs-haskell/cem-script/blob/master/src/Cardano/CEM/Documentation.hs), rendered example below,
+  [PR](https://github.com/mlabs-haskell/cem-script/pull/33))
+
+## State graph examples
+
+![](./auction-state-graph.svg)
+
+
+Source code:
+
+```
+digraph Creator {
+rankdir=LR;
+node [shape="dot",fontsize=14,fixedsize=true,width=1.5];
+edge [fontsize=11];"Void In" [color="orange"];"Void Out" [color="orange"];"Void In" -> NotStarted [label="Create (stage Open)"];
+NotStarted -> CurrentBid [label="Start (stage Open)"];
+CurrentBid -> CurrentBid [label="MakeBid (stage Open)"];
+CurrentBid -> Winner [label="Close (stage Closed)"];
+Winner -> "Void Out" [label="Buyout (stage Closed)"];
+}
+```

docs/goals_and_soa.md

@@ -2,13 +2,16 @@
 
 ## Why Cardano DApp modeling language is important?
 
-While prototypes can be easily constructed with existing Cardano frameworks, making it secure and production ready is sisyphean task.
+While prototypes can be easily constructed with existing Cardano frameworks,
+making it secure and production ready is sisyphean task.
 
-We believe, that onchain PL improvements by themselves could not change that. Only higher-level modeling framework can lead to reliable DApp production.
+We believe, that onchain PL improvements by themselves could not change that.
+Only higher-level modeling framework can lead to reliable DApp production.
 
 In following enumerate our high-level design goals
 and demonstrate them by list of specific problems
 arising in existing DApps codebase.
+
 Such problems are specific security vulnerabilities types
 and various kinds development, audit and support cost increase.
 After that we examine how existing solutions