Skip to content

Commit

Permalink
docs: add test report (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
hadelive authored May 4, 2024
1 parent 9a1e82c commit a819397
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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<a, b>`. Note that `a` is the type of
Expand Down
Binary file modified assets/images/aiken-design-patterns.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/test_report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a819397

Please sign in to comment.