Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address some comments in #377 #388

Merged
merged 7 commits into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/00_getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ to compile, execute, and finalize its state autonomously.
# What's new on Aleo?
### [**🔧 Getting Ready for Testnet Beta**](./leo/16_testnet_beta.md) - A guide on updating your Leo applications for Testnet Beta.
### [**🤝 Leo Core Developers Call**](./leo/15_core_devs_call.md) - Collaborate with the Leo development team and ecosystem on the future of Leo.
### [**⚛️ Create Aleo App**](./sdk/create-aleo-app/01_create_aleo_app.md) - A full stack application written in Typescript using Leo and React.
### [**⚛️ Create Aleo App**](./sdk/create-leo-app/01_create_leo_app.md) - A full stack application written in Typescript using Leo and React.
### [**🧰 Leo Developer Toolkit**](./testnet/getting_started/04_developer_toolkit.md) - A zero to one tutorial for the Leo programming language.
:::

Expand Down
5 changes: 3 additions & 2 deletions documentation/00_sdk_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ first zero knowledge web app.
#### Source: [`sdk/sdk`](https://github.com/AleoHQ/sdk/tree/testnet3/sdk)


## 2. [Create-leo-App](./sdk/create-aleo-app/00_app_installation.md) - Zero-Knowledge Web App Examples
## 2. [Create-leo-App](./sdk/create-leo-app/00_app_installation.md) - Zero-Knowledge Web App Examples

<a href="https://www.npmjs.com/package/create-leo-app"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/create-aleo-app?label=NPM%20-%20Create-Aleo-App&labelColor=green&color=blue" /></a>
<a href="https://www.npmjs.com/package/create-leo-app"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/create-aleo-app?label=NPM%20-%20Create-Leo-App&labelColor=green&color=blue" /></a>

Create-leo-app provides zero-knowledge web app examples in common web frameworks such as React. Developers looking to
start with working examples should start here.
Expand All @@ -47,6 +47,7 @@ You can start with a template by running
npm create leo-app@latest
```


#### Source: [`sdk/create-leo-app`](https://github.com/ProvableHQ/sdk/tree/testnet3/create-leo-app)

## 3. [Aleo-Wasm](./sdk/wasm/00_wasm_installation.md) - Zero Knowledge Algorithms in JavaScript + WebAssembly
Expand Down
2 changes: 2 additions & 0 deletions documentation/concepts/06_public_private.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ sidebar_label: Public vs. Private State
---

## Introduction
<!-- markdown-link-check-disable -->
The concept of Zero Knowledge proofs was first introduced in 1985 in the paper [The Knowledge Complexity of Interactive Proof Systems](https://epubs.siam.org/doi/10.1137/0218012?utm_source=the+new+stack&utm_medium=referral&utm_content=inline-mention&utm_campaign=tns+platform). However, it is only in recent years that the groundbreaking technology has been feasible to be applicable to blockchains.
<!-- markdown-link-check-enable -->

Zcash was one of the earliest chains to utilize the power of zero knowledge proofs to provide privacy to an account's balance. Unlike traditional cryptocurrencies like Bitcoin, where transaction details are publicly visible on the blockchain, Zcash enables users to shield their transactions, rendering them completely opaque to outside observers. It utilizes zk-SNARKs (Zero-Knowledge Succinct Non-Interactive Argument of Knowledge), a type of zero-knowledge proof system that allows parties to verify the validity of a computation without revealing the underlying data.

Expand Down
210 changes: 100 additions & 110 deletions documentation/leo/03_language.md

Large diffs are not rendered by default.

1,613 changes: 808 additions & 805 deletions documentation/leo/04_operators.md

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion documentation/leo/07_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,9 @@ as well as the recommended code solution.

### Conditional Branches

Conditional `if else` statements in Leo are expensive. It is preferred to use ternary `? :` expressions.
The Leo compiler rewrites if-else statements inside `transitions` into a sequence of ternary expressions.
This is because the underlying circuit construction does not support branching.
For precise control over the circuit size, it is recommended to use ternary expressions directly.

```leo title="Example:"
if (condition) {
Expand Down
4 changes: 4 additions & 0 deletions documentation/leo/15_core_devs_call.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@ We welcome everyone to join!
### When
**Every Tuesday 9-10AM PT, starting on 5/21/24**

<!-- markdown-link-check-disable -->

### Where
**Google Meet**
- Video call link: https://meet.google.com/eup-twjf-zbv
- Or dial: (US) +1 409-263-1346, PIN: 181 961#
- More phone numbers: https://tel.meet/eup-twjf-zbv?pin=7908874492618

<!-- markdown-link-check-enable -->

### Agenda
- Team Updates:
- Leo Roadmap
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: installation
title: Create Aleo App
title: Create Leo App
sidebar_label: Installation
---

<a href="https://www.npmjs.com/package/create-aleo-app"> <img alt="Create Aleo App" src="https://img.shields.io/npm/l/create-aleo-app?label=NPM%20-%20Create-Aleo-App&labelColor=green&color=blue" /></a>
<a href="https://www.npmjs.com/package/create-leo-app"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/create-leo-app?label=NPM%20-%20Create-Leo-App&labelColor=green&color=blue" /></a>

## Scaffolding Your First Aleo Project

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: tutorial
title: Create Aleo App - React + JS + Leo Tutorial
title: Create Leo App - React + JS + Leo Tutorial
sidebar_label: React + JS + Leo Tutorial
---

<a href="https://www.npmjs.com/package/create-aleo-app"> <img alt="Create Aleo App" src="https://img.shields.io/npm/l/create-aleo-app?label=NPM%20-%20Create-Aleo-App&labelColor=green&color=blue" /></a>
<a href="https://www.npmjs.com/package/create-leo-app"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/create-leo-app?label=NPM%20-%20Create-Leo-App&labelColor=green&color=blue" /></a>


## 1. Installation
Expand Down
8 changes: 4 additions & 4 deletions documentation/sdk/typescript/00_sdk_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The Aleo SDK provides the following functionality (Click to see examples):
* [Installation](#Installation)
* [Usage](#Usage)
* [Zero Knowledge Web App Examples](#Zero-Knowledge-Web-App-Examples)
* [Create Aleo App](#create-aleo-app)
* [Create Leo App](#create-leo-app)
* [provable.tools](#provabletools)
* [Create An Aleo Account](#1-create-an-aleo-account)
* [Execute Aleo Programs](#2-execute-aleo-programs)
Expand Down Expand Up @@ -75,9 +75,9 @@ To build the project from source, go to this project's root and execute:

## Zero Knowledge Web App Examples

### Create Aleo App
### Create Leo App
A set of fully functional examples of zero knowledge web apps can be found in
[create-aleo-app](https://github.com/AleoHQ/sdk/tree/testnet3/create-aleo-app). Create-aleo-app provides several web-app
[create-leo-app](https://github.com/AleoHQ/sdk/tree/testnet3/create-leo-app). Create-aleo-app provides several web-app
templates in common web frameworks such as React that can be used as a starting point for building zero knowledge web apps.

Developers can get started immediately with create-react-app by running:
Expand Down Expand Up @@ -663,7 +663,7 @@ Make sure that you included custom types in your `tsconfig` file.
</details>


A full example of this implementation can be found [here](https://github.com/AleoHQ/sdk/blob/testnet3/create-aleo-app/template-react-leo/src/App.jsx)
A full example of this implementation can be found [here](https://github.com/AleoHQ/sdk/blob/testnet3/create-leo-app/template-react-leo/src/App.jsx)

## 3. Aleo Credit Transfers

Expand Down
4 changes: 2 additions & 2 deletions documentation/sdk/wasm/00_wasm_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ sidebar_label: Installation
---

<!-- markdown-link-check-disable -->
<a href="https://www.npmjs.com/package/@aleohq/wasm"> <img alt="Create Aleo App" src="https://img.shields.io/npm/l/%40aleohq%2Fwasm?label=NPM%20-%20Aleo%20Wasm&labelColor=green&color=blue" /></a>
<a href="https://www.npmjs.com/package/@aleohq/nodejs"> <img alt="Create Aleo App" src="https://img.shields.io/npm/l/%40aleohq%2Fnodejs?label=NPM%20-%20Aleo%20Nodejs&labelColor=green&color=blue" /></a>
<a href="https://www.npmjs.com/package/@aleohq/wasm"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/%40aleohq%2Fwasm?label=NPM%20-%20Aleo%20Wasm&labelColor=green&color=blue" /></a>
<a href="https://www.npmjs.com/package/@aleohq/nodejs"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/%40aleohq%2Fnodejs?label=NPM%20-%20Aleo%20Nodejs&labelColor=green&color=blue" /></a>
<a href="https://crates.io/crates/aleo-wasm"> <img alt="Aleo-Wasm" src="https://img.shields.io/crates/v/aleo-wasm.svg?color=neon" /></a>

[![github]](https://github.com/AleoHQ/sdk)&ensp;[![crates-io]](https://crates.io/crates/aleo-wasm)&ensp;[![docs-rs]](https://docs.rs/aleo-wasm/latest/aleo-wasm/)
Expand Down
Loading