diff --git a/README.md b/README.md index 70e6193..908b67b 100644 --- a/README.md +++ b/README.md @@ -62,8 +62,18 @@ cd aiken-design-patterns aiken build ``` +3. Execute the test suite: + +```sh +aiken check +``` + ![aiken-design-patterns.gif](/assets/images/aiken-design-patterns.gif) +Test results: + +![test_report.png](/assets/images/test_report.png) + ## Provided Patterns ### Stake Validator @@ -204,6 +214,7 @@ within the limits of Cardano. > more info. The exposed `spend` function from `merkelized_validator` expects 3 arguments: + 1. The hash of the withdrawal validator that performs the computation. 2. The list of arguments expected by the underlying logic. 3. The `Dict` of all redeemers within the current script context. @@ -217,6 +228,7 @@ safely use them. For defining a withdrawal logic that carries out the computation, use the exposed `withdraw` function. It expects 3 arguments: + 1. The computation itself. It has to take a list of generic inputs, and return a list of generic outputs. 2. A redeemer of type `WithdrawRedeemer`. Note that `a` is the type of diff --git a/assets/images/aiken-design-patterns.gif b/assets/images/aiken-design-patterns.gif index 62e9ab4..39c2a8c 100644 Binary files a/assets/images/aiken-design-patterns.gif and b/assets/images/aiken-design-patterns.gif differ diff --git a/assets/images/test_report.png b/assets/images/test_report.png new file mode 100644 index 0000000..3c22616 Binary files /dev/null and b/assets/images/test_report.png differ