leo/README.md

The Leo Programming Language

Leo is a functional, statically-typed programming language built for writing private applications.

Table of Contents

• 🍎 Overview
• ⚙️️ Build Guide
  • 🦀 Install Rust
  • 🐙 Build from Source Code
• 🚀 Quick Start
• 🧰 Troubleshooting
• 📖 Documentation
• 🤝 Contributing
• ❤️ Contributors
• 🛡️ License

🍎 Overview

Welcome to the Leo programming language.

Leo provides a high-level language that abstracts low-level cryptographic concepts and makes it easy to integrate private applications into your stack. Leo compiles to circuits making zero-knowledge proofs practical.

The syntax of Leo is influenced by traditional programming languages like JavaScript, Scala, and Rust, with a strong emphasis on readability and ease-of-use. Leo offers developers with tools to sanity check circuits including unit tests, integration tests, and console functions.

Leo is one part of a greater ecosystem for building private applications on Aleo. The language is currently in an alpha stage and is subject to breaking changes.

⚙️️ Build Guide

🦀 Install Rust

We recommend installing Rust using rustup. You can install rustup as follows:

• macOS or Linux:

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  

• Windows (64-bit):

  Download the Windows 64-bit executable and follow the on-screen instructions.

• Windows (32-bit):

  Download the Windows 32-bit executable and follow the on-screen instructions.

🐙 Build from Source Code

We recommend installing Leo by building from the source code as follows:

# Download the source code
git clone https://github.com/AleoHQ/leo
cd leo

# Install 'leo'
$ cargo install --path .

Now to use leo, in your terminal, run:

leo

🚀 Quick Start

Use the Leo CLI to create a new project

# create a new `hello-world` Leo project
leo new helloworld
cd helloworld

# build & setup & prove & verify
leo run

The leo new command creates a new Leo project with a given name.

The leo run command will compile the program into Aleo instructions and run it.

Congratulations! You've just run your first Leo program.

🧰 Troubleshooting

If you are having trouble installing and using Leo, please check out our guide.

If the issue still persists, please open an issue.

📖 Documentation

• Hello World - Next Steps
• Leo Language Documentation
• Leo ABNF Grammar
• Homepage

🤝 Contributing

Please see our guidelines in the developer documentation

❤️ Contributors

Thank you for helping make Leo better!
What do the emojis mean?🧐

d0cd 💻 🚧 💬 👀	Collin Chin 💻 📖 🚧 👀	Howard Wu 🤔 🚧 🔬 👀	Alessandro Coglio 📖 🚧 💬 👀	Eric McCarthy 📖 🚧 💬 👀	Raymond Chu 🤔 💻 🔬	ljedrz 🐛 💻 💬
aharshbe ✅🐛 💬	Mazdak Farrokhzad 💻	Damir Shamanaev 💻	gluax 💻	0rphon 💻	Max Bruce 💻	Sergey Isaev 💻
François Garillot 💻	Weikeng Chen 🔬	sptg 🐛 💻	LouisWT 💻	yuliyu123 💻	detailyang 💻	Tom-OriginStorage 💻
omahs 💻	Haruka 🐛 💻	swift-mx 💻	Francisco Strambini 💻	Daniel Gushchyan ✅	r4keta ✅	liolikus 🖋
Evgeny Garanin ✅	NickoMenty ✅	eug33ne ✅	Nininiao ✅	CTurE1 ✅🖋	colliseum2006 ✅	boaaa ✅
HausenUA ✅	TerrenceTepezano ✅	Zabka0x94 ✅	DarronHanly1 ✅	FengXiaoYong ✅	KassieSteinman ✅	MaishaAzim ✅
Moria Bright ✅	Bradshow ✅	SilvaHoffarth ✅	Elaine1015 ✅	vasylbelyi ✅	EgorMajj ✅	RNS23 ✅
VoinaOleksandr ✅	alexprimak58 ✅	Asimous22 ✅	Marik0023 ✅	JanSchluter ✅	AminaPerrigan ✅	Utah8O ✅
ApoloniaResseguie ✅	NobukoCausley ✅	ololo70 ✅	evangelion4215 ✅	boodovskiy ✅	BULVER777 ✅	Kyrylo Budovskyi ✅
sayber1717 ✅	BudiSwy ✅	romacll ✅	habaroff18203 ✅	LennyPro6 ✅	n0d4 ✅	grossbel12 ✅
Orliha ✅	darjin 🖋	romacll ✅	aleoweb123 ✅	Andrew Rosborough 🖋	R-Demon ✅	sryykov ✅
himera0482 ✅	encipher88 ✅	Likaenigma ✅	bartosian ✅	Recep Deniz ✅	Saimon87 ✅	Big Ixela ✅
Denys Riabets ✅	Dmytro Groma ✅	Volodymyr Rudoi ✅	Petro Falatiuk ✅	ElsaChill ✅	gsulaberidze ✅	kegvorn ✅
totoro_me ✅	timchinskiyalex ✅	DimaSpys ✅	dimbirch ✅	YuraPySHIT ✅	annabirch ✅	baxzban ✅
nnewera3 ✅	LabLinens ✅	drimartist ✅	savarach ✅	padjfromdota ✅	gglorymen ✅	KrisMorisBoris ✅
WebDuster ✅	Tasham2008 ✅	760AnaPY ✅	imshelest ✅	mirmalnir ✅	AnatoliMP ✅	ihortym ✅
Vplmrchk ✅	anrd04 ✅	Gonruk ✅	ur4ix ✅	AllininanQ ✅	Juliaaa26 ✅	Hacker-web-Vi ✅
Mickey1245 ✅	anastese ✅	NastyaTR97 ✅	andriypaska ✅	dendistar ✅	kartaviy223 ✅	BluePEz ✅
Ihorika2 ✅	taraspaska ✅	Ragnaros12q ✅	StasFreeman ✅	McTrick ✅	Dimaleron ✅	Boruto11dw ✅
NOne790 ✅	Golldirr ✅	dmytriievp ✅	InfernoCyber55 ✅	dexxeed ✅	kumarman1 ✅	nika040 ✅
Collins44444444444444 ✅	aavegotch ✅	Sergiy Svitlyk ✅	Mariia077 ✅	svitlykihor ✅	Dmytro Haiov ✅	Annnnnnnnnnna ✅
turchmanovich101 ✅	Zasmin12ve ✅	timfaden ✅	MerlinKlasnuy ✅	erikprimerov ✅	Andreewko ✅	Daniel Nguyen ✅
igorstrong ✅	Kramar Maxim ✅	Marina Boyko ✅	YaakovHuang ✅	viktoria3715 ✅	Hello-World99bit ✅	Alan-Zarevskij ✅
Huliko ✅	tommy1qwerty ✅	sueinz ✅	Julia-path ✅	Diana Shershun ✅	mcnk020 ✅	Edgar0515 ✅
Ju1issa ✅	MGavrilo ✅	YujiROO1 ✅	yuriyMiller ✅	Tetiana Pavlenko ✅	MGavrilo ✅	vizimnokh ✅
Oleksii Svitlyk ✅	t3s1 ✅	BloodBand ✅	thereisnspoon ✅	InfernoCyber55 ✅	Pikkorio1 ✅	quertc ✅
Yuriihrk ✅	stsefa ✅	Alan Harper ✅	imanbtc ✅	Oleksandr7744 ✅	MarikJudo ✅	Piermanenta ✅
Karoliniio ✅	Olga Svitlyk ✅	khanaya9845 ✅	OlgaBurd ✅	YaakovHunag920515 ✅	Songoku1691 ✅	Timssse ✅
LLoyD1337 ✅	VeranOAS ✅	kirileshta ✅	dimapr1 ✅	senol10 ✅	hoangsoncomputer ✅	Timssse ✅
Erskine2022 ✅	HoratioElise ✅	0xKateKasper ✅	Dekigrupovuha ✅	ariaSiren ✅	musicplayli ✅	cryptotuts ✅
grojap ✅	Chinothebuilder ✅	Dorafanboy ✅	lockck ✅	RoyalHelena ✅	0xHeathcliff ✅	Elvira0728 ✅
NerissaHal ✅	beoloqer ✅	goshina2015 ✅	Khvesyk ✅	LuchikYu ✅	alekseevaani22 ✅	sasaglim ✅
ChinW ✅	abasinv577 ✅	JeTr1x ✅	grejio ✅	mehgoq ✅	SerdhRo ✅	poizu ✅
petrzhukovam ✅	BeniukBohdan ✅	romasamiilenko ✅	Yserdych ✅	Andriasniy ✅	ishaaqziyan ✅	yutkach ✅
Mernajop ✅	GudanovaAngelina ✅	Ruguped ✅	jackhopper925 ✅	sadnessdog123 ✅	ivanuykolegmy ✅	olefirenkoannaa ✅
KislitsinSergey ✅	RuslanKhvan ✅	rozhnovskiyigor ✅	mihalchukdenis ✅	StarkovVlad ✅	ErikTruman ✅	yeeeeeeeeehor ✅
coco94542 ✅	smetaninalena ✅	LoyalLea ✅	mihalchukdenis ✅	jessandrich ✅	TanTanyaYa ✅	changnum05 ✅
nastyQueen ✅	lunaryear123 ✅	aiootv ✅	Lalabnb ✅	SunSeva ✅	ElleryRiley ✅	sheridan2020 ✅
mgpwnz ✅	Podima2 ✅	DomWyatt ✅	stan-dot ✅	podpolkovnik123 ✅	Dmitriy65 ✅	sheridan2020 ✅
Dominik77Aleo ✅	luo-simon ✅	WargerCoderApt ✅	jan-o-e ✅	SimonSallstrom ✅	yashgo0018 ✅	jessicapointing ✅
zklim ✅	EfrainHattie ✅	jacobella ✅	brandonseverin ✅	14viktor14 ✅	AntonYashcheko ✅	elenavicario12 ✅
tbretschneider ✅	scmata ✅	perlash73 ✅	velev ✅	some-robot-guy ✅	bvs321 ✅	3tomcha ✅
StephenPan ✅	rolloorme ✅	tommyet ✅	Hun-Chi33 ✅	Cheliooosss ✅	TSetsenkoU ✅	TropicalDog17 ✅
HartleyGilda ✅	kelsey2821 ✅	diane8026 ✅	MavisPrunella ✅	Margaret-Hamilton-AR ✅	ollstar41 ✅	JustAnotherDevv ✅
abiyeamachree ✅	CaptainAhab0x ✅	dradaku ✅	carlosaccp ✅	anitatrista ✅	anonyma ✅	JohnT2222 ✅
EmersonLois ✅	Anneki1 ✅	GillianWolf ✅	davaks2 ✅	chidz21 ✅	l1irosh ✅	jaklin55noso ✅
jess98NFT ✅	alexisleger-42 ✅	DrucillaLucas ✅	ThaliaElsie ✅	0xK3K ✅	daniel023x ✅	ellen2martin ✅
Fanat1ck1 ✅	GoldenFirst5 ✅	Flyingtothemoon123 ✅	davinlane ✅	arianarhea ✅	zambrose ✅	Jarekkkkk ✅
akirawuc ✅	tralkan ✅	abcd5251 ✅	andy78644 ✅	ineedmoti ✅	christam96 ✅	cindlin ✅
atul2501 ✅	effiehattie ✅	chaoticsoooul ✅	nancy42071 ✅	albertwong08 ✅	garrickmaxwell ✅	Bipin102 ✅
Qgoni ✅	nonkung51 ✅	AZLPY3117G ✅	Hesus1love ✅	PhilbertHu ✅	elliottstefan ✅	yadavmunny06 ✅
fentonrobin ✅	FireGuyYehorPotiekhin ✅	sapphire712 ✅	spawnpeeker ✅	fizzixesp ✅	lydiaignatova ✅	Suraj-1407 ✅
jsreddy3 ✅	chrerokiy01 ✅	zelenenola ✅	HenryLeslie ✅	vancemichelle ✅	ua-lera ✅	MJV11 ✅
juicc3 ✅	DyxaDevelop 🖋	MrSinisterF ✅	es3tenz ✅	thrashcomplet ✅	agladkyi ✅	ShiftyBlock ✅
AdityaAA2004 ✅	zainashaik ✅	KoshliakOleksandr ✅	Pidogryz ✅	OleksandrSlipchenko ✅	MykhailoReztsov ✅	kirkelmer ✅
philbertotis ✅	isaiahelvis0x ✅	WenQi7721 ✅	CharlesMing02 ✅	AliceYeh12 ✅	patilmayank ✅	kilikaloko214 ✅
AlexZhao6666 🖋	chenxudongok ✅
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

🛡️ License

🔼 Back to top