7e309eccdb
* Add initial docs generation website (#119) * Add docs generation * [makefile] add serve-docs target * Fixed rebase conflicts * Update pre-commit rev * Added changelog
2.6 KiB
MiniJuvix
<a href="https://github.com/heliaxdev/minijuvix/blob/main/LICENSE">
<img alt="LICENSE" src="
" />
</a>
<a href="https://github.com/heliaxdev/MiniJuvix/actions/workflows/ci.yml">
<img alt="CI status" src="
" />
</a>
<a href="https://github.com/heliaxdev/minijuvix/tags"> <img alt="" src="https://img.shields.io/github/v/release/heliaxdev/minijuvix?include_prereleases" /> </a>
Description
MiniJuvix is a programming language for writing efficient formally-verified validity predicates, which can be deployed to various distributed ledgers. This is software released for experimentation and research purposes only. No warranty is provided or implied.
MiniJuvix addresses many issues that we have experienced while trying to write and deploy decentralized applications present in the ecosystem of smart-contracts:
- the difficulty of adequate program verification,
- the ceiling of compositional complexity,
- the illegibility of execution costs, and
- the lock-in to particular backends.
Quick Start
To install MiniJuvix, you can download its sources using Git from the Github repository. Then, the program can be downloaded and installed with the following commands. You will need to have Stack installed.
git clone https://github.com/heliaxdev/minijuvix.git
cd minijuvix
stack install
If the installation succeeds, you must be able to run the minijuvix
command from any location. To get the complete list of commands, please
run minijuvix --help.
Usage Example
In the following example a MiniJuvix file is compiled using the C backend. The result is compiled to WASM using Clang and then executed using wasmer.
NB: Set the WASI_SYSROOT_PATH environment variable to the root of the WASI sysroot. See Dependencies for instructions on how to install the sysroot.
cd tests/positive/MiniC/HelloWorld
minijuvix minic Input.mjuvix | clang --target=wasm32-wasi -nodefaultlibs -lc --sysroot $WASI_SYSROOT_PATH -I../../../../minic-runtime/libc -x c - -o out.wasm && wasmer out.wasmhello world!
Other Documentation
Community
We would love to hear what you think of MiniJuvix! Join us on Discord