Skip to content

Commit b5d96e3

Browse files
author
euonymos
committed
chore: update milestone 5 report
1 parent ea46b36 commit b5d96e3

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

docs/catalyst_milestone_reports.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Milestone 5
22

3-
## Summary
3+
## Summary of deliverables
44

55
* L1 indexing:
66
* [Basic indexing support PR #98](https://github.com/mlabs-haskell/cem-script/pull/98)
@@ -14,21 +14,17 @@
1414
* [PR on docs](https://github.com/mlabs-haskell/cem-script/pull/115)
1515
* [Getting Started Guide](https://github.com/mlabs-haskell/cem-script/pull/115/files#diff-31bcba2ccafa41d46fbbd6d1219f7f1e3b1fb3cad9faa8e4dc521bbb579dd7b3)
1616
* Updated [Goals And Design](https://github.com/mlabs-haskell/cem-script/pull/115/files#diff-ef1a1e144302d41f2687f34dc1885cd8434e6395aa5443c81a2bca8414911972)
17-
* [Closeout video](TODO: link)
18-
19-
## Clarifications on M3 Deliverables
20-
21-
### Running an Emulated Environment by CLB
22-
23-
The CLB monad is designed to interact seamlessly with a Cardano mockchain environment. It can read from a shared environment, query blockchain parameters such as the current slot, and retrieve UTXO information, among other functions. This module facilitates simulation and testing, making it essential for unit tests and other testing scenarios where a controlled blockchain environment is needed. Using this emulated environment, developers can test and validate their Cardano applications in a reliable and repeatable manner.
24-
25-
### Running QuickCheck Dynamic Tests, Including Mutation Support
17+
* [Closeout video](TODO:link)
2618

27-
QuickCheck is a powerful Haskell library for property-based testing, which helps ensure that programs behave correctly for a wide range of inputs. The quickcheck-dynamic library extends this tool to stateful systems, making it particularly suitable for testing blockchain applications. Our testing framework uses a state machine model to simulate real-world scenarios, incorporating support for mutation testing. This approach helps verify that the system maintains correct behavior under various conditions, including edge cases and unexpected changes, thereby enhancing the robustness of the application.
19+
## Clarifications on M5 deliverables
2820

29-
### Rendering CEMScript State Graphs
21+
in the final milestone we added support for indexing CEM Scripts based on
22+
[Oura](https://github.com/txpipe/oura) utility. The framework provide utilities
23+
to generate Oura's configs and parse transaction from Oura-based format into
24+
CEM Script transitions.
3025

31-
Understanding state transitions and the overall system flow is critical for ensuring blockchain applications do not enter invalid states. To aid developers, we have implemented automated rendering of state graphs through our documentation module. This module generates DOT graph representations of CEMScript state transitions, providing an easy-to-understand visual model of how a DApp functions in real-world scenarios. This visualization tool increases developer confidence by highlighting the system's behavior and identifying potential shortcomings.
26+
The documentation has been reworked. Getting started guide has beeen added.
27+
An introductory video on CEM Script has been recorded and published on YouTube.
3228

3329
# Milestone 4
3430

0 commit comments

Comments
 (0)