1
1
mirror of https://github.com/anoma/juvix.git synced 2024-12-01 00:04:58 +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
Łukasz Czajka b95abeaada
Restructure the documentation and add a tutorial (#1718)
* Closes #1597 
* Closes #1624 
* Closes #1633 

The tutorial uses syntax which has not been implemented yet: it depends
on
- #1637, 
- #1716, 
- #1639,
- #1638.

The tutorial also assumes the following issues are done: 
- #1720, and
- #1701.

Co-authored-by: Jonathan Cubides <jonathan.cubides@uib.no>
2023-01-19 13:28:21 +01:00
.devcontainer Add initial setup for codespaces (#1713) 2023-01-18 11:25:18 +01:00
.github Use Smoke instead of shelltestrunner (#1710) 2023-01-10 12:49:56 +01:00
app Refactor html command with extra options (#1725) 2023-01-17 18:11:59 +01:00
assets Refactor html command with extra options (#1725) 2023-01-17 18:11:59 +01:00
bench Automatized benchmarks (#1673) 2023-01-05 17:48:26 +01:00
c-runtime Fix Nat builtins (#1733) 2023-01-17 17:11:31 +01:00
docker Upgrade stack snapshot to use ghc-9.2.5 (#1621) 2022-12-02 10:04:56 +01:00
docs/org Restructure the documentation and add a tutorial (#1718) 2023-01-19 13:28:21 +01:00
examples Restructure the documentation and add a tutorial (#1718) 2023-01-19 13:28:21 +01:00
gnuplot Automatized benchmarks (#1673) 2023-01-05 17:48:26 +01:00
juvix-mode Add an emacs function to restart the REPL (#1618) 2022-11-14 09:38:07 +00:00
juvix-stdlib@19d957eb8f Fix Nat builtins (#1733) 2023-01-17 17:11:31 +01:00
licenses Add Haddock and Agda licenses (#1506) 2022-09-06 09:30:01 +01:00
runtime JuvixCore to JuvixAsm translation (#1665) 2023-01-09 18:21:30 +01:00
src/Juvix Translate 'let' to Core (#1740) 2023-01-19 12:56:37 +01:00
test Translate 'let' to Core (#1740) 2023-01-19 12:56:37 +01:00
tests Translate 'let' to Core (#1740) 2023-01-19 12:56:37 +01:00
.clang-format Juvix C runtime (#1580) 2022-11-03 09:38:09 +01:00
.github_changelog_generator Update Changelog v0.2.3 🎉 2022-08-15 12:24:42 +02:00
.gitignore Automatized benchmarks (#1673) 2023-01-05 17:48:26 +01:00
.gitmodules Rename MiniJuvix to Juvix (#259) 2022-07-08 13:59:45 +02:00
.hlint.yaml Monomorphization (#70) 2022-05-04 10:50:03 +02:00
.pre-commit-config.yaml Fix Changelog links and minors (#1371) 2022-07-14 11:41:58 +02:00
.pre-commit-hooks.yaml Add initial documentation (#119) (#120) 2022-05-23 16:20:02 +02:00
book.toml Rename MiniJuvix to Juvix (#259) 2022-07-08 13:59:45 +02:00
cabal.hie.yaml Automatized benchmarks (#1673) 2023-01-05 17:48:26 +01:00
cabal.project Update stack.yaml (#1734) 2023-01-18 10:23:14 +01:00
changelog.org Refactor html command with extra options (#1725) 2023-01-17 18:11:59 +01:00
cntlines.sh Script to count LOC (#1732) 2023-01-17 15:32:05 +01:00
LICENSE First commit, initial project template. 2021-09-26 18:59:51 +02:00
Makefile Restructure the documentation and add a tutorial (#1718) 2023-01-19 13:28:21 +01:00
package.yaml Refactor html command with extra options (#1725) 2023-01-17 18:11:59 +01:00
README.org Restructure the documentation and add a tutorial (#1718) 2023-01-19 13:28:21 +01:00
stack.hie.yaml Refactor hie.yaml and add entry in the readme (#1672) 2022-12-20 16:45:48 +01:00
stack.yaml Update stack.yaml (#1734) 2023-01-18 10:23:14 +01:00

Juvix

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

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

<a href="https://github.com/anoma/juvix/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/codespaces/new?hide_repo_select=true&ref=main&repo=455254004"> <img height="20pt" alt="Open the Juvix Standard Lib in Github Codespace" src="https://github.com/codespaces/badge.svg" /> </a>

<a href="https://github.com/anoma/juvix"> <img align="right" width="300" height="300" alt="Juvix Mascot" src="assets/images/tara-seating.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 language and related tools are documented in the Juvix book. To write and test Juvix programs, you can use your favorite text editor, the juvix command line tool, the Juvix Github Codespace, and the Juvix Standard Lib Codespace. However, we recommend using the juvix-mode in Emacs or the plugin in VSCode.

Quick start

See Quick start to start with Juvix.

The Juvix programming language

Juvix provides a high degree of assurance. The Juvix compiler runs several static analyses which guarantee the absence of runtime errors. Analyses performed include termination, arity, and type checking. As a result, functional programs, especially validity predicates, can be written with greater confidence in their correctness.

Some of the language features in Juvix include:

  • unicode syntax
  • parametric polymorphism
  • inductive and parametric data types
  • higher-order functions
  • implicit arguments
  • holes in expressions
  • axioms for non-computable terms

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 further details, please refer to the Juvix book which includes our latest updates.

Community

Join us on our Discord server

This project is part of a bigger effort called Anoma. Anoma is a suite of protocols and mechanisms for self-contained, self-sovereign coordination. Join the Anoma project.