30ae6c76c4
* Documment a few language features * Add an example for foreign example * Fix pre-commit warnings * remove what-is-org * Ignore README.org in docs folder * Add fixes for revisions
4.8 KiB
Juvix
<a href="https://github.com/anoma/juvix/actions/workflows/ci.yml">
<img alt="CI status" src="
" />
</a>
<a href="https://github.com/anoma/juvix/tags"> <img alt="" src="https://img.shields.io/github/v/release/anoma/juvix?include_prereleases" /> </a>
<a href="https://github.com/anoma/juvix/blob/main/LICENSE">
<img alt="LICENSE" src="
" />
</a>
<a href="https://github.com/anoma/juvix/actions/workflows/pages/pages-build-deployment"><img
src="
"
alt="pages-build-deployment" /></a>
<a href="https://github.com/anoma/juvix"> <img align="right" width="300" height="300" alt="Juvix Mascot" src="assets/seating-mascot.051c86a.svg" /> </a>
Description
Juvix is a research programming language created by Heliax as a first step toward creating more robust and reliable alternatives for formally verified smart contracts than existing languages. The Juvix language is constantly evolving, open-source, functional, and statically typed with special support for compiling validity predicates to the C language, which can be deployed to various distributed ledgers including Anoma.
The Juvix programming language allows developers to write programs with a high degree of assurance that they will meet specific standards. This is due to the fact that several static analyses are performed during compilation, including, for example, scope, termination, arity, and type checking. As a result, functional programs, especially validity predicates, can be written with greater confidence that they will be free of runtime errors.
The language features:
- unicode syntax
- parametric polymorphism
- inductive and parametric data types
- higher-order functions
- implicit arguments
- holes in programs
- axioms for non-computable terms
Additionally, the foreign and compile blocks syntax enable developers to compile a program to different backends including the C language. The Juvix module system further permits splitting programs into several modules to build libraries which can be later documented by generating HTML files based on the codebase, see for example, the Juvix standard library's website. For futher details, please refer to the Juvix book which icludes our latest updates.
Examples of programs written in Juvix
The following links are clickable versions of their corresponding Juvix programs. The HTML output can be generated by running juvix html --recursive FileName.juvix.
Quick Start
To install Juvix, 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 --recursive https://github.com/anoma/juvix.git
cd juvix
stack install
If the installation succeeds, you must be able to run the Juvix
command from any location. To get the complete list of commands, please
run juvix --help.
Usage Example
In the following example a Juvix 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 Installing dependencies for instructions on how to install the
sysroot.
cd tests/positive/MiniC/HelloWorld
juvix compile Input.juvix
wasmer Input.wasm
You should see the output: hello world!
The Juvix Book
The Juvix language and related tools are documented in the Juvix book.
Community
We would love to hear what you think of Juvix! Join us on the Anoma Discord.