Skip to content

Commit

Permalink
Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
d0cd committed Aug 1, 2024
2 parents d83218b + c9550d5 commit 07ecd3a
Show file tree
Hide file tree
Showing 37 changed files with 235 additions and 134 deletions.
6 changes: 3 additions & 3 deletions documentation/00_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ An index of all pages available in this documentation.
- [Blocks](./concepts/05_blocks.md)
- [Public vs. Private State](./concepts/06_public_private.md)

## Testnet III
## Testnet

### Chapter 5: Getting Started

- [Testnet III.](./testnet/getting_started/00_overview.md)
- [Testnet](./testnet/getting_started/00_overview.md)

### Chapter 6: API Reference

Expand All @@ -78,7 +78,7 @@ An index of all pages available in this documentation.
- [Get Mapping Names](./testnet/public_endpoints/11_get_mapping_names.md)
- [Get Mapping Value](./testnet/public_endpoints/12_get_mapping_value.md)
- [Get State Path for Commitment](./testnet/public_endpoints/13_get_state_path_for_commitment.md)
- [Get Beacons](./testnet/public_endpoints/14_get_beacons.md)
- [Get Committee](./testnet/public_endpoints/14_get_committee.md)
- [Get Peers Count](./testnet/public_endpoints/15_get_peers_count.md)
- [Get Peers All](./testnet/public_endpoints/16_get_peers_all.md)
- [Get Peers All Metrics](./testnet/public_endpoints/17_get_peers_all_metrics.md)
Expand Down
26 changes: 13 additions & 13 deletions documentation/00_sdk_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,21 @@ sidebar_label: Overview
---


The [Aleo SDK](https://github.com/AleoHQ/sdk) provides tools for building zero knowledge applications. It consists of
The [Aleo SDK](https://github.com/ProvableHQ/sdk) provides tools for building zero knowledge applications. It consists of
several TypeScript & JavaScript libraries which provide the following functionality:
1. [Aleo account management](https://provable.tools/account)
2. [Web-based program execution and deployment](https://provable.tools/develop)
3. [Aleo credit transfers](https://provable.tools/transfer)
4. [Management of program state and data](https://provable.tools/record)
5. [Communication with the Aleo network](https://provable.tools/rest)

All of this functionality is demonstrated on [Aleo.tools](https://provable.tools).

All of this functionality is demonstrated on [provable.tools](https://www.provable.tools/).

The Aleo SDK is divided into three Typescript/Javascript packages

## 1. [Aleo SDK](./sdk/typescript/00_sdk_overview.md) - Build Zero Knowledge Web Apps

<a href="https://www.npmjs.com/package/@aleohq/sdk"> <img alt="Aleo SDK" src="https://img.shields.io/npm/l/%40aleohq%2Fsdk?label=NPM%20-%20Aleo%20SDK&labelColor=green&color=blue" /></a>
<a href="https://www.npmjs.com/package/@provablehq/sdk"> <img alt="Aleo SDK" src="https://img.shields.io/npm/l/%40aleohq%2Fsdk?label=NPM%20-%20Aleo%20SDK&labelColor=green&color=blue" /></a>


The official Aleo SDK providing Javascript/Typescript tools for creating zero knowledge apps.
Expand All @@ -33,11 +32,11 @@ first zero knowledge web app.
#### Source: [`sdk/sdk`](https://github.com/AleoHQ/sdk/tree/testnet3/sdk)


## 2. [Create-Aleo-App](./sdk/create-leo-app/00_app_installation.md) - Zero Knowledge Web App Examples
## 2. [Create-leo-App](./sdk/create-aleo-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-leo-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-aleo-app provides zero-knowledge web app examples in common web frameworks such as React. Developers looking to
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.

### ⚡ Build your own app
Expand All @@ -48,20 +47,21 @@ You can start with a template by running
npm create leo-app@latest
```

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

#### 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

<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://www.npmjs.com/package/@provablehq/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://crates.io/crates/aleo-wasm"> <img alt="Aleo-Wasm" src="https://img.shields.io/crates/v/aleo-wasm.svg?color=neon" /></a>

Aleo Wasm is a Rust crate which compiles Aleo code responsible for creating and executing zero knowledge programs into
WebAssembly.

When compiled with `wasm-pack` JavaScript bindings are generated for the WebAssembly allowing Aleo zero
knowledge programs to be used in the browser and NodeJS. This package is available on NPM (linked above). The
[documentation](./sdk/wasm/00_wasm_installation.md) provides instructions for compiling this [crate](https://github.com/AleoHQ/sdk/tree/testnet3/wasm) and using it in web projects for those interested in building from
[documentation](./sdk/wasm/00_wasm_installation.md) provides instructions for compiling this [crate](https://github.com/ProvableHQ/sdk/tree/testnet3/wasm) and using it in web projects for those interested in building from
source.

❗ Currently program execution is only available in web Browsers. However, account, program and data management within
Expand Down Expand Up @@ -89,10 +89,10 @@ Source: [`python-sdk`](https://github.com/AleoHQ/python-sdk)
API Documentation, tutorials for the Aleo SDK, and documentation on how to build Leo and Aleo Instructions programs can
be found on the [Aleo Developer Docs](https://developer.aleo.org) page.

#### [SDK Readme](https://github.com/AleoHQ/sdk/tree/testnet3/sdk#readme)
#### [SDK Readme](https://github.com/ProvableHQ/sdk/tree/testnet3/sdk#readme)
The SDK Readme provides concepts core to executing zero knowledge programs in the web and several detailed examples of
how to use the SDK to build web apps using Aleo.

#### [Aleo Wasm Readme](https://github.com/AleoHQ/sdk/tree/testnet3/wasm#readme)
#### [Aleo Wasm Readme](https://github.com/ProvableHQ/sdk/tree/testnet3/wasm#readme)
The Aleo Wasm Readme provides instructions for compiling the Aleo Wasm crate and using it in web projects. Those who
want to build from source or create their own WebAssembly bindings should start here
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
4 changes: 4 additions & 0 deletions documentation/leo/16_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
2 changes: 1 addition & 1 deletion documentation/sdk/create-leo-app/00_app_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Create Leo App
sidebar_label: Installation
---

<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-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
2 changes: 1 addition & 1 deletion documentation/sdk/create-leo-app/01_create_leo_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Create Leo App - React + JS + Leo Tutorial
sidebar_label: React + JS + Leo Tutorial
---

<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-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
28 changes: 14 additions & 14 deletions documentation/testnet/getting_started/00_overview.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
id: overview
title: Testnet III.
title: Testnet.
sidebar_label: Overview
---

:::note
Aleo Testnet III is **not** ready for production use and will undergo thorough audit and testing before reaching production.
Aleo Testnet III is a trusted testnet - subsequent testnets will undergo a trusted setup process.
Testnet Beta is **not** ready for production use and will undergo thorough audit and testing before reaching production.
Testnet Beta is a trusted testnet - subsequent testnets will undergo a trusted setup process.
:::

**Aleo Testnet III** is an experimental network for developers to begin building and testing applications on Aleo.
Testnet III is used by the core team for designing and evaluating new programs, planning and staging network upgrades,
**Testnet Beta** is an experimental network for developers to begin building and testing applications on Aleo.
Testnet Beta is used by the core team for designing and evaluating new programs, planning and staging network upgrades,
and running experimental features for inclusion on mainnet.

## snarkOS
Expand All @@ -24,27 +24,27 @@ enables developers to checkpoint and finalize application state in a publicly-ve

## Query The Network

The Aleo Testnet3 API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).
The Aleo Testnet API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).

To connect to the network, make a request to an Aleo Testnet III bootnode.
To connect to the network, make a request to an Aleo Testnet bootnode.
<!-- markdown-link-check-disable -->

| URL |
|------------------|
| [https://api.explorer.aleo.org/v1/testnet3](https://api.explorer.aleo.org/v1/testnet3/) |
| [https://api.explorer.aleo.org/v1/testnet](https://api.explorer.aleo.org/v1/testnet/) |

For example, you can [retrieve the current block height](https://api.explorer.aleo.org/v1/testnet3/latest/height).
For example, you can [retrieve the current block height](https://api.explorer.aleo.org/v1/testnet/latest/height).

With a local instance of `snarkos`, you can launch a client node with:

```
snarkos start --client --nodisplay
```

By default, this will make the node API available at `0.0.0.0:3033`:
By default, this will make the node API available at `0.0.0.0:3030`:

```
http://0.0.0.0:3033/testnet3/latest/height
http://0.0.0.0:3030/testnet/latest/height
```

Now, refer to the [API reference](#api) for a list of available endpoints.
Expand All @@ -55,10 +55,10 @@ Now, refer to the [API reference](#api) for a list of available endpoints.
If you have Docker installed you can quickly launch a client within a docker container:

```
docker run -it --name snarkos --hostname snarkosc -p 4133:4133 -p 3033:3033 --mount type=bind,source="$(pwd)",target=/aleo/data aleohq/snarkos:latest /aleo/bin/snarkos start --client --nodisplay
docker run -it --name snarkos --hostname snarkosc -p 4130:4130 -p 3033:3033 --mount type=bind,source="$(pwd)",target=/aleo/data aleohq/snarkos:latest /aleo/bin/snarkos start --client --nodisplay
```

This initializes a container called `snarkos` and maps the container port `3033` to `3033` on your system. Once the client is initialized, you can access the API as usual (`http://0.0.0.0:3033/testnet3/latest/height`).
This initializes a container called `snarkos` and maps the container port `3030` to `3030` on your system. Once the client is initialized, you can access the API as usual (`http://0.0.0.0:3030/testnet/latest/height`).

You can close the container with `ctrl` + `c` and restart it with:

Expand All @@ -81,7 +81,7 @@ docker start -a snarkos
- [Get Mapping Names](../public_endpoints/11_get_mapping_names.md)
- [Get Mapping Value](../public_endpoints/12_get_mapping_value.md)
- [Get State Path for Commitment](../public_endpoints/13_get_state_path_for_commitment.md)
- [Get Beacons](../public_endpoints/14_get_beacons.md)
- [Get Committee](../public_endpoints/14_get_committee.md)
- [Get Peers Count](../public_endpoints/15_get_peers_count.md)
- [Get Peers All](../public_endpoints/16_get_peers_all.md)
- [Get Peers All Metrics](../public_endpoints/17_get_peers_all_metrics.md)
Expand Down
Loading

0 comments on commit 07ecd3a

Please sign in to comment.