Skip to content

Commit

Permalink
docs: update API endpoint, links to sdk and rename testnet3 to testnet
Browse files Browse the repository at this point in the history
  • Loading branch information
zklimaleo committed Sep 24, 2024
1 parent d6a6b40 commit ee9c63b
Show file tree
Hide file tree
Showing 66 changed files with 230 additions and 231 deletions.
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
url = https://github.com/AleoNet/snarkOS.git
[submodule "leo"]
path = leo
url = https://github.com/AleoHQ/leo
url = https://github.com/provablehq/leo
[submodule "aleo-setup"]
path = aleo-setup
url = https://github.com/AleoNet/aleo-setup
Expand All @@ -12,4 +12,4 @@
url = https://github.com/AleoNet/snarkVM.git
[submodule "sdk"]
path = sdk
url = https://github.com/AleoHQ/sdk.git
url = https://github.com/provablehq/sdk.git
66 changes: 33 additions & 33 deletions README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ Clone the `snarkOS` repository
git clone https://github.com/AleoNet/snarkOS.git --depth 1
cd snarkOS

# Switch to the testnet3 branch
git checkout testnet3
# Switch to the mainnet-staging branch
git checkout mainnet-staging

[For Ubuntu users] A helper script to install dependencies is available. From the snarkOS directory, run:

Expand Down Expand Up @@ -112,7 +112,7 @@ Clone the `leo` repository

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

Expand Down Expand Up @@ -238,7 +238,7 @@ This is similar to the Linux/MacOS instructions.
Clone the `leo` repository using git bash
```bash
# Download the source code
git clone https://github.com/AleoHQ/leo
git clone https://github.com/provablehq/leo
cd leo
```

Expand Down Expand Up @@ -282,8 +282,8 @@ cargo install --path .

To improve the developer experience, Aleo has provided extensions for syntax highlighting for your popular code editors.
- [VSCode](https://code.visualstudio.com/download)
- Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from VSCode marketplace.
- The correct extension ID is aleohq.leo-extension, and the description should state "the official VSCode extension for Leo".
- Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=provablehq.leo-extension) from VSCode marketplace.
- The correct extension ID is provablehq.leo-extension, and the description should state "the official VSCode extension for Leo".
- [IntelliJ](https://www.jetbrains.com/idea/download/?section=mac)
- [Extension here](https://plugins.jetbrains.com/plugin/19890-aleo-developer)
- Click on the gear icon in the upper right > Plugins > gear icon up top > Install Plugin from Disk > Select the downloaded zip file
Expand Down Expand Up @@ -325,7 +325,7 @@ Although this command is used to run a function, it also builds your program.
## Deploy

```
snarkos developer deploy {$PROGRAM_NAME} --private-key {$PRIVATE_KEY} --query "https://api.explorer.aleo.org/v1" --path ".build/" --broadcast "https://api.explorer.aleo.org/v1/testnet3/transaction/broadcast" --priority-fee 0
snarkos developer deploy {$PROGRAM_NAME} --private-key {$PRIVATE_KEY} --query "https://api.explorer.provable.com/v1" --path ".build/" --broadcast "https://api.explorer.provable.com/v1/testnet/transaction/broadcast" --priority-fee 0
```
If successful, it should look something like
![Deploy confirmation](./images/deploy-confirmation.png)
Expand All @@ -334,7 +334,7 @@ The hash at the bottom of the image represents the transaction hash, which you c

## Execute
```
snarkos developer execute {$PROGRAM_NAME} {$TRANSITION_NAME} {$INPUT_ARGUMENTS} --private-key {$PRIVATE_KEY} --query "https://api.explorer.aleo.org/v1" --broadcast "https://api.explorer.aleo.org/v1/testnet3/transaction/broadcast"
snarkos developer execute {$PROGRAM_NAME} {$TRANSITION_NAME} {$INPUT_ARGUMENTS} --private-key {$PRIVATE_KEY} --query "https://api.explorer.provable.com/v1" --broadcast "https://api.explorer.provable.com/v1/testnet/transaction/broadcast"
```
If successful, it should look something like
![Execute confirmation](./images/execute-confirmation.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Record private data is encoded as a list of field elements which is encrypted wi

This process enables users to securely and privately transfer data and values across the network. A key aspect of this system is that only the sender and receiver, who each possess their respective view keys, can unlock and access the contents of these records. This safeguard ensures that sensitive information is protected from unauthorized access while maintaining transparency and trust in the transaction process, providing a robust foundation for secure communications.

The code for encryption and decryption is available in the snarkVM sections, which can be accessed at the [encrypt](https://github.com/AleoNet/snarkVM/blob/testnet3/circuit/program/src/data/record/encrypt.rs) and [decrypt](https://github.com/AleoNet/snarkVM/blob/testnet3/circuit/program/src/data/record/decrypt.rs) pages, respectively.
The code for encryption and decryption is available in the snarkVM sections, which can be accessed at the [encrypt](https://github.com/AleoNet/snarkVM/blob/mainnet-staging/circuit/program/src/data/record/encrypt.rs) and [decrypt](https://github.com/AleoNet/snarkVM/blob/mainnet-staging/circuit/program/src/data/record/decrypt.rs) pages, respectively.

Additionally, users can decrypt their encrypted records using their view key via a web interface available at [Provable Tools](https://www.provable.tools/record). This feature allows for the practical application of decryption processes directly through a browser.

Expand Down Expand Up @@ -126,7 +126,7 @@ We must start by defining our `record` named 'token.
amount: u64,
}

Then, we will be able to mint 50 tokens to Alice's wallet. Full [token example](https://github.com/AleoHQ/workshop/blob/master/token/src/main.leo) can be found in token workshop. For now, we will cover the record outputs.
Then, we will be able to mint 50 tokens to Alice's wallet. Full [token example](https://github.com/aleonet/workshop/blob/master/token/src/main.leo) can be found in token workshop. For now, we will cover the record outputs.

First, alice mints 50 tokens with `mint_private` transition and gets the following output:
```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Provers are an integral part of the Aleo network but do not participate in Aleo'

In the long term, the *CoinbaseReward* incentive that Provers can obtain is directly proportional to their computational power relative to the entire network. The economic incentive for Provers is similar to PoW in Bitcoin, but unlike Bitcoin, Aleo's network doesn't employ a winner-takes-all strategy. As long as the *ProverSolution* satisfies the *ProofTarget*, it is accepted by the network. This approach ensures fairer and more stable rewards for Provers. It's noteworthy that unlike the *BlockReward* for validators, the *CoinbaseReward* decreases over time, reducing by 10% annually until there are no *CoinbaseReward* incentives after 10 years.

Users can view CoinbaseReward, BlockReward, and PuzzleReward through the [browser](https://testnet3.aleoscan.io/).
Users can view CoinbaseReward, BlockReward, and PuzzleReward through the [browser](https://testnet.aleoscan.io/).

> PuzzleReward = CoinbaseReward * 2/3
>
Expand Down
2 changes: 1 addition & 1 deletion documentation/00_aleo_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Read the full list of supported [AVM opcodes](./aleo/04_opcodes.md).

Check your program or compiler implementation against the [Aleo instructions grammar](./aleo/06_grammar.md).

Study the formal [ABNF grammar specification](https://github.com/AleoNet/grammars) for the full formal syntax of Aleo instructions.
Study the formal [ABNF grammar specification](https://github.com/ProvableHQ/grammars) for the full formal syntax of Aleo instructions.

## Command Line Interface Documentation

Expand Down
6 changes: 3 additions & 3 deletions 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/17_testnet_beta.md) - A guide on updating your Leo applications for Testnet Beta.
### [**🤝 Leo Core Developers Call**](./leo/16_core_devs_call.md) - Collaborate with the Leo development team and ecosystem on the future of Leo.
### [**⚛️ Create Leo App**](./sdk/create-aleo-app/01_create_aleo_app.md) - A full stack application written in Typescript using Leo and React.
### [**⚛️ Create Leo 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 Expand Up @@ -70,7 +70,7 @@ If you're interested in learning more about Aleo:

<!-- markdown-link-check-disable -->
[//]: # (disabling markdown checks for twitter links)
🐦 | Twitter ~ @AleoHQ ~ **https://twitter.com/AleoHQ**
🐦 | Twitter ~ @AleoHQ ~ **https://twitter.com/aleohq**

🤝 | Community Twitter ~ @aleocommunity ~ **https://twitter.com/aleocommunity**

Expand All @@ -84,6 +84,6 @@ If you're interested in learning more about Aleo:

🔎 | Aleo Block Explorer ~ **https://www.aleo.network/**

✍️ | Community Blog ~ **https://medium.com/@AleoHQ**
✍️ | Community Blog ~ **https://medium.com/@provablehq**

### Looking for [**Developer Resources?**](./leo/08_resources.md)
6 changes: 3 additions & 3 deletions documentation/00_leo_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Overview
Welcome to the Leo programming language. Leo is a statically-typed programming language for private applications. Designed for intuitive Aleo blockchain development, Leo lays the foundation for a private, decentralized ecosystem.

:::info
The Leo language is currently in active development. Please monitor the repository on [**GitHub**](https://github.com/AleoHQ/leo) for possibly breaking changes.
The Leo language is currently in active development. Please monitor the repository on [**GitHub**](https://github.com/provablehq/leo) for possibly breaking changes.
:::

## Installing Leo
Expand All @@ -30,7 +30,7 @@ For a quick reference of Leo syntax, see the [**Leo Cheat Sheet**](./leo/09_chea

## Formal Language Documentation

A formal ABNF grammar specification for the syntax of Leo can be viewed [here](https://github.com/AleoHQ/grammars/blob/master/leo.abnf).
A formal ABNF grammar specification for the syntax of Leo can be viewed [here](https://github.com/provablehq/grammars/blob/master/leo.abnf).

## Command Line Interface Documentation

Expand All @@ -55,7 +55,7 @@ For additional developer resources such as examples and community projects, see

Is your Leo code formatted correctly? Check out the [**Style Guide**](./leo/08_resources.md#style-guide) and [**Common Patterns**](./leo/08_resources.md#common-patterns) for the official guidelines.

Found a bug? Have an idea for a feature? File an issue on the [**Leo GitHub**](https://github.com/AleoHQ/leo/issues/new/choose).
Found a bug? Have an idea for a feature? File an issue on the [**Leo GitHub**](https://github.com/provablehq/leo/issues/new/choose).

See the [**Contributing Guide**](./leo/08_resources.md#contributing) for more information.

Expand Down
38 changes: 19 additions & 19 deletions documentation/00_sdk_overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: sdk
title: Aleo SDK
title: Provable SDK
sidebar_label: Overview
---


The [Aleo SDK](https://github.com/AleoHQ/sdk) provides tools for building zero knowledge applications. It consists of
The [Provable 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)
Expand All @@ -16,28 +16,28 @@ several TypeScript & JavaScript libraries which provide the following functional
All of this functionality is demonstrated on [Aleo.tools](https://provable.tools).


The Aleo SDK is divided into three Typescript/Javascript packages
The Provable SDK is divided into three Typescript/Javascript packages

## 1. [Aleo SDK](./sdk/typescript/00_sdk_overview.md) - Build Zero Knowledge Web Apps
## 1. [Provable 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="Provable SDK" src="https://img.shields.io/npm/l/%40provablehq%2Fsdk?label=NPM%20-%20Aleo%20SDK&labelColor=green&color=blue" /></a>


The official Aleo SDK providing Javascript/Typescript tools for creating zero knowledge apps.
The official Provable SDK providing Javascript/Typescript tools for creating zero knowledge apps.

### ⚡ Build your own app

Start here with the [documentation](./sdk/typescript/00_sdk_overview.md) and follow the instructions to install the [Aleo SDK](https://github.com/AleoHQ/sdk/tree/testnet3/sdk#readme) to get started building your
Start here with the [documentation](./sdk/typescript/00_sdk_overview.md) and follow the instructions to install the [Provable SDK](https://github.com/provablehq/sdk/tree/testnet3/sdk#readme) to get started building your
first zero knowledge web app.

#### Source: [`sdk/sdk`](https://github.com/AleoHQ/sdk/tree/testnet3/sdk)
#### Source: [`sdk/sdk`](https://github.com/provablehq/sdk/tree//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-leo-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,26 +48,26 @@ You can start with a template by running
npm create leo-app@latest
```

#### Source: [`sdk/create-aleo-app`](https://github.com/ProvableHQ/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 Leo App" src="https://img.shields.io/npm/l/%40provablehq%2Fwasm?label=NPM%20-%20Aleo%20Wasm&labelColor=green&color=blue" /></a>
<a href="https://www.npmjs.com/package/@provablehq/nodejs"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/%40provablehq%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
NodeJS is functional.

Source: [`sdk/wasm`](https://github.com/AleoHQ/sdk/tree/testnet3/wasm)
Source: [`sdk/wasm`](https://github.com/provablehq/sdk/tree/testnet3/wasm)

## 4. Aleo Python SDK - Zero Knowledge Algorithms in Python and Zero Knowledge Machine Learning

Expand All @@ -80,19 +80,19 @@ Both libraries are in an early development stage. They can be installed through
[documentation on the aleo library](./sdk/python/00_aleo_sdk.md) and the [documentation on the zkml library](./sdk/python/01_zkml_transpiler.md) provide more information on installation and usage.

<!-- markdown-link-check-disable -->
Source: [`python-sdk`](https://github.com/AleoHQ/python-sdk)
Source: [`python-sdk`](https://github.com/provablehq/python-sdk)
<!-- markdown-link-check-enable -->

## 📚 Documentation

#### [API Documentation](https://developer.aleo.org)
API Documentation, tutorials for the Aleo SDK, and documentation on how to build Leo and Aleo Instructions programs can
API Documentation, tutorials for the Provable 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: 1 addition & 1 deletion documentation/aleo/02_hello.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ You can find your development application address inside the `.env` file:
```json
{
NETWORK=testnet3
NETWORK=testnet
PRIVATE_KEY=APrivateKey1zkpFsQNXJwdvjKs9bRsM91KcwJW1gW4CDtF3FJbgVBAvPds
}
```
Expand Down
4 changes: 2 additions & 2 deletions documentation/aleo/03_language.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Function outputs must be declared at the end of the function definition.

In the Aleo protocol, calling a function creates a transition that can consume and produce records on-chain.
Use the `aleo run` CLI command to pass inputs to a function and execute the program.
In Testnet3, program functions cannot call other internal program functions.
In Testnet, program functions cannot call other internal program functions.
If you would like to develop "helper functions" that are called internally within a program, try writing a `closure`.

#### Call an Imported Function
Expand Down Expand Up @@ -656,7 +656,7 @@ The `self.caller` command returns the address of the immediate caller of the pro
The examples in this section will use the following environment.

```bash title=".env"
NETWORK=testnet3
NETWORK=testnet
PRIVATE_KEY=APrivateKey1zkpE37QxQynZuEGg3XxYrTuvhzWbkVaN5NgzCdEGzS43Ms5 # user private key
ADDRESS=aleo1p2h0p8mr2pwrvd0llf2rz6gvtunya8alc49xldr8ajmk3p2c0sqs4fl5mm # user address
```
Expand Down
2 changes: 1 addition & 1 deletion documentation/aleo/06_grammar.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Grammar
---

This chapter contains a high-level grammar of Aleo instructions.
A more detailed ABNF grammar can be found [here](https://github.com/AleoHQ/grammars).
A more detailed ABNF grammar can be found [here](https://github.com/provablehq/grammars).

```
program = *import
Expand Down
Loading

0 comments on commit ee9c63b

Please sign in to comment.