1
1
mirror of https://github.com/anoma/juvix.git synced 2024-12-14 17:32:00 +03:00
Juvix empowers developers to write code in a high-level, functional language, compile it to gas-efficient output VM instructions, and formally verify the safety of their contracts prior to deployment and execution.
Go to file
janmasrovira 9e6d43dd60
Allow jumping to another module in emacs (#249)
allow jumping to another module in emacs
2022-07-06 12:21:04 +01:00
.github/workflows Embed standard library in the minijuvix binary (#210) 2022-06-30 11:31:08 +02:00
app Removes the minihaskell command from CLI (#244) 2022-07-05 15:39:45 +02:00
assets Restore Juvix mascot image to README (#248) 2022-07-06 11:49:58 +02:00
docs/org Removed tests/positive/HelloWorld.mjuvix and specified clang version in the documentation 2022-07-04 14:27:24 +02:00
examples/milestone Support partial application and closure passing in C backend (#190) 2022-06-28 10:25:43 +02:00
minic-runtime Add support for built in types (#192) 2022-06-28 13:31:31 +02:00
minijuvix-mode Allow jumping to another module in emacs (#249) 2022-07-06 12:21:04 +01:00
minijuvix-stdlib@eab18bdae0 Update stdlib to work with version 0.2 (#160) 2022-06-14 13:34:17 +02:00
src/MiniJuvix Allow jumping to another module in emacs (#249) 2022-07-06 12:21:04 +01:00
test Throw error when reading a file that conflicts with embedded stdlib (#243) 2022-07-05 15:54:01 +02:00
tests Remove the 'match' keyword (#238) 2022-07-05 16:09:13 +02:00
.github_changelog_generator v0.2.0 (#198) 2022-06-28 16:31:02 +02:00
.gitignore Update validity predicate milestone example to 0.2 syntax (#167) 2022-06-15 13:04:14 +02:00
.gitmodules [ CI ] Add Haskell Github Action with Stack test and ormolu check 2022-04-04 15:55:15 +02:00
.hlint.yaml Monomorphization (#70) 2022-05-04 10:50:03 +02:00
.pre-commit-config.yaml Restore Juvix mascot image to README (#248) 2022-07-06 11:49:58 +02:00
.pre-commit-hooks.yaml Add initial documentation (#119) (#120) 2022-05-23 16:20:02 +02:00
book.toml Add initial documentation (#119) (#120) 2022-05-23 16:20:02 +02:00
hie.yaml Generic Errors and refactoring (#123) 2022-05-26 17:52:08 +02:00
LICENSE First commit, initial project template. 2021-09-26 18:59:51 +02:00
Makefile Add CLI improvements and shell testing (#131) 2022-06-09 16:36:07 +02:00
package.yaml Unify MicroJuvix ASTs representation of types and expressions (#188) 2022-07-04 18:15:35 +02:00
README.org Restore Juvix mascot image to README (#248) 2022-07-06 11:49:58 +02:00
stack.yaml Upgrade to ghc-9.2.3 (#178) 2022-06-20 12:53:31 +02:00

MiniJuvix

<a href="https://github.com/heliaxdev/MiniJuvix/actions/workflows/ci.yml"> <img alt="CI status" src="https://github.com/heliaxdev/MiniJuvix/actions/workflows/ci.yml/badge.svg" /> </a>

<a href="https://github.com/heliaxdev/minijuvix/blob/main/LICENSE"> <img alt="LICENSE" src="https://img.shields.io/badge/license-GPL--3.0--only-blue.svg" /> </a>

<a href="https://github.com/heliaxdev/minijuvix/actions/workflows/pages/pages-build-deployment"><img src="https://github.com/heliaxdev/minijuvix/actions/workflows/pages/pages-build-deployment/badge.svg" alt="pages-build-deployment" /></a>

<a href="https://github.com/heliaxdev/MiniJuvix"> <img align="right" width="300" height="300" alt="MiniJuvix Mascot" src="assets/seating-mascot.051c86a.svg" /> </a>

Description

MiniJuvix 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 MiniJuvix 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 MiniJuvix 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. Here are some examples of MiniJuvix programs.

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 MiniJuvix 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 Minijuvix standard library's website. For futher details, please refer to the MiniJuvix book which icludes our latest updates.

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 --recursive 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 Installing dependencies for instructions on how to install the sysroot.

cd tests/positive/MiniC/HelloWorld
minijuvix compile Input.mjuvix
wasmer Input.wasm

You should see the output: hello world!

The MiniJuvix Book

The MiniJuvix language and related tools are documented in the MiniJuvix book.

Community

We would love to hear what you think of MiniJuvix! Join us on Discord