Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
OlofBlomqvist committed Jul 17, 2023
1 parent 6bdbfc7 commit 50d8be1
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ An **experimental** Rust implementation of Marlowe for Cardano smart (financial

Note that while there is support for encoding and decoding on-chain data, this crate focuses on the off-chain parts, making it as easy as possible to create, manage and understand contracts in Rust; there will not be any support for creating actual transactions.

There is also no support for directly communicating with any Cardano or Marlowe infrastructure - this is purely an implementation of the datatypes, semantics and serialization for Marlowe.

### Main Features
- Encode/Decode Marlowe types between: MarloweDSL/Rust/Json/CborHex
- List contract parameters used in a contract (extended marlowe)
Expand All @@ -25,12 +27,17 @@ Note that while there is support for encoding and decoding on-chain data, this c
This crate can be used in Rust, React, Node, Deno etc., see the examples directory for more details. It will also be possible to compile to WASI soon™.
Note that the wasm file is quite large (at 3MB~) right now. This is expected to change in the future to below 300kb, but it is not a priority right now.

### To do's

### WIP & TODOs

- Add [marlowe-spec-test](https://github.com/input-output-hk/marlowe/tree/master/marlowe-spec-test) to build pipeline when it has been properly packaged.

- Rewrite parser logic to use Chumsky.

- Replace CML with Pallas

- Provide support for WASI compilation

## CLI Tool:

### Installation:
Expand Down

0 comments on commit 50d8be1

Please sign in to comment.