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

replaces AleoHQ with ProvableHQ in GitHub URLs #402

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
10 changes: 5 additions & 5 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[submodule "snarkOS"]
path = snarkOS
url = https://github.com/AleoHQ/snarkOS.git
url = https://github.com/ProvableHQ/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/AleoHQ/aleo-setup
url = https://github.com/ProvableHQ/aleo-setup
[submodule "snarkVM"]
path = snarkVM
url = https://github.com/AleoHQ/snarkVM.git
url = https://github.com/ProvableHQ/snarkVM.git
[submodule "sdk"]
path = sdk
url = https://github.com/AleoHQ/sdk.git
url = https://github.com/ProvableHQ/sdk.git
62 changes: 31 additions & 31 deletions README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ Note: After installation, if your `git` and `rustc` command doesn't work, try to
Clone the `snarkOS` repository

```bash
git clone https://github.com/AleoHQ/snarkOS.git --depth 1
git clone https://github.com/ProvableHQ/snarkOS.git --depth 1
cd snarkOS

# Switch to the mainnet branch
git checkout mainnet
git checkout mainnet

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

Expand All @@ -67,7 +67,7 @@ Note that the dot at the end of the command is required.
cargo install --path .
```

To test if your snarkOS is working, try typing
To test if your snarkOS is working, try typing
```bash
snarkos
```
Expand All @@ -77,28 +77,28 @@ You should see something like:

Please ensure ports 4133/tcp and 3033/tcp are open on your router and OS firewall.

For more details about how to use `snarkOS` CLI, check out [this link](https://github.com/AleoHQ/snarkOS).
For more details about how to use `snarkOS` CLI, check out [this link](https://github.com/ProvableHQ/snarkOS).

If you would like to run a local devnet, run the command

```bash
./devnet.sh
```

You would however, first need to install tmux. Instructions can be found on the github [repo](https://github.com/AleoHQ/snarkOS)
You would however, first need to install tmux. Instructions can be found on the github [repo](https://github.com/ProvableHQ/snarkOS)

### Install SnarkVM
- Install snarkVM from the github [repo](https://github.com/AleoHQ/snarkvm)
- Install snarkVM from the github [repo](https://github.com/ProvableHQ/snarkvm)

```
# Download the source code
git clone https://github.com/AleoHQ/snarkvm && cd snarkvm
git clone https://github.com/ProvableHQ/snarkvm && cd snarkvm

# Install snarkVM
$ cargo install --path .
```

To test if snarkVM was installed successfully go to the command line and type
To test if snarkVM was installed successfully go to the command line and type
```bash
snarkvm
```
Expand All @@ -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 All @@ -125,7 +125,7 @@ cargo install --path .

That will generate the executable ~/.cargo/bin/leo.

To test if leo was installed successfully, try typing
To test if leo was installed successfully, try typing
```bash
leo
```
Expand All @@ -134,7 +134,7 @@ You should see something like:
![leo installation](./images/leo-install-success.png)
For more details about how to use `leo` Cli, check out [this link](https://developer.aleo.org/leo/commands)

---
---

## Docker

Expand All @@ -156,15 +156,15 @@ docker run -it 0xaragondocker/leo_docker /bin/bash
## Windows Installation with Git Bash

### Rust Installation
Rust runs on many platforms, and there are many ways to install Rust. This guide describes installation via rustup, a tool that manages multiple Rust toolchains in a consistent way across all platforms Rust supports.
Rust runs on many platforms, and there are many ways to install Rust. This guide describes installation via rustup, a tool that manages multiple Rust toolchains in a consistent way across all platforms Rust supports.
- On Windows, download and run [rustup-init.exe](https://static.rust-lang.org/rustup/dist/i686-pc-windows-gnu/rustup-init.exe)
- rustup-init can be configured interactively, and all options can additionally be controlled by command-line arguments, which can be passed through the shell script. Pass --help to rustup-init as follows to display the arguments rustup-init accepts:
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --help
```
- The above command needs to executed using WSL
- If you prefer not to use the shell script, you may directly download rustup-init for windows [here](https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe)
- verify rust installation by runnin ```rustc --version``` in wsl
- verify rust installation by runnin ```rustc --version``` in wsl


### Git
Expand All @@ -186,7 +186,7 @@ Rust runs on many platforms, and there are many ways to install Rust. This guide

- In the "Workloads" tab enable "Desktop development with C++"
![Desktop Development with C++](./images/desktop-development-c++.png)
- Click Modify to install
- Click Modify to install


### LLVM Installation
Expand All @@ -207,23 +207,23 @@ Rust runs on many platforms, and there are many ways to install Rust. This guide
Using git bash, clone the `snarkOS` repository

```bash
git clone https://github.com/AleoHQ/snarkOS.git --depth 1
git clone https://github.com/ProvableHQ/snarkOS.git --depth 1
cd snarkOS
cargo install --locked --path .
```

### Install SnarkVM
Using git bash, install snarkVM from the github [repo](https://github.com/AleoHQ/snarkvm)
Using git bash, install snarkVM from the github [repo](https://github.com/ProvableHQ/snarkvm)

```
# Download the source code
git clone https://github.com/AleoHQ/snarkvm && cd snarkvm
git clone https://github.com/ProvableHQ/snarkvm && cd snarkvm

# Install snarkVM
$ cargo install --path .
```

To test if snarkVM was installed successfully go to the command line and type
To test if snarkVM was installed successfully go to the command line and type
```bash
snarkvm
```
Expand All @@ -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 All @@ -251,7 +251,7 @@ cargo install --path .

That will generate the executable ~/.cargo/bin/leo.

To test if leo was installed successfully, try typing
To test if leo was installed successfully, try typing
```bash
leo
```
Expand Down Expand Up @@ -280,7 +280,7 @@ cargo install --path .

## Install `leo` IDE Syntax Highlighting:

To improve the developer experience, Aleo has provided extensions for syntax highlighting for your popular code editors.
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".
Expand All @@ -293,7 +293,7 @@ To improve the developer experience, Aleo has provided extensions for syntax hig

## Aleo Wallet Installation
Using a chrome browser, install either of these chrome extensions to get an Aleo wallet. You can also request for testnet tokens from these wallets.
- [Leo Wallet](https://chromewebstore.google.com/detail/leo-wallet/nebnhfamliijlghikdgcigoebonmoibm)
- [Leo Wallet](https://chromewebstore.google.com/detail/leo-wallet/nebnhfamliijlghikdgcigoebonmoibm)
- [Puzzle Wallet](https://chromewebstore.google.com/detail/puzzle-aleo-wallet/fdchdcpieegfofnofhgdombfckhbcokj)

---
Expand All @@ -302,7 +302,7 @@ Using a chrome browser, install either of these chrome extensions to get an Aleo

1) Open terminal
2) Go to the folder where you cloned the snarkos repository [earlier](#install-snarkos).
3) run the command
3) run the command
```
./devnet.sh
```
Expand All @@ -316,7 +316,7 @@ Using a chrome browser, install either of these chrome extensions to get an Aleo
# Interacting with your program on testnet

## Build Your Program
First build you program by running
First build you program by running
```
leo run {$TRANSITION_NAME} {$INPUTS}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Nonce
The serial number nonce is used to create a unique identifier for each record, and is computed via a PRF evaluation of the address secret key ask of the owner and the record's serial number.


An example record can be shown below by calling the mint_private transition from the token workshop:
An example record can be shown below by calling the mint_private transition from the token workshop:
```bash
{
owner: aleo13ssze66adjjkt795z9u5wpq8h6kn0y2657726h4h3e3wfnez4vqsm3008q.private,
Expand Down Expand Up @@ -115,7 +115,7 @@ The Alice's wallet is:
`aleo1mgfq6g40l6zkhsm063n3uhr43qk5e0zsua5aszeq5080dsvlcvxsn0rrau`

The Bob's wallet is:
`aleo1r0dry2tlhjt0yplctz85692kjpqsadn7xgxsmrehkasykjxynypqza3fpl`
`aleo1r0dry2tlhjt0yplctz85692kjpqsadn7xgxsmrehkasykjxynypqza3fpl`

We must start by defining our `record` named 'token.

Expand All @@ -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/ProvableHQ/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 Expand Up @@ -218,9 +218,3 @@ The inputs ‘input’ and ‘input1’ are the records that are imported from t
In the example, a record generated by credits.aleo is again spent by the program itself. While our example program is still unable to consume the record, it can work with a record from a different program.

By using external records, programs can interact with each other's records without breaking privacy and eliminating the limitations on developing dApps.






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.

> PuzzleReward = CoinbaseReward * 2/3
> PuzzleReward = CoinbaseReward * 2/3
>
> BlockReward = 23.8 + CoinbaseReward * 1 / 3
>
Expand All @@ -26,4 +26,4 @@ Besides requiring ProverSolutions to be valid, the network also demands that the

### Become a Prover Node

Becoming a Prover node does not require staking or authorization, anyone can [start a Prover node](https://github.com/AleoHQ/snarkOS?tab=readme-ov-file#32-run-an-aleo-prover).
Becoming a Prover node does not require staking or authorization, anyone can [start a Prover node](https://github.com/ProvableHQ/snarkOS?tab=readme-ov-file#32-run-an-aleo-prover).
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Before beginning, please ensure your machine has `Rust v1.66+` installed. Instru

Start by cloning this GitHub repository:
```
git clone https://github.com/AleoHQ/snarkOS.git --depth 1
git clone https://github.com/ProvableHQ/snarkOS.git --depth 1
```

Next, move into the `snarkOS` directory:
Expand Down Expand Up @@ -184,4 +184,4 @@ OPTIONS:
2. Sign a message with your private key using `snarkos account sign --raw -m "Message" --private-key-file=<PRIVATE_KEY_FILE>`
3. Verify your signature with `snarkos account verify --raw -m "Message" -s sign1SignatureHere -a aleo1YourAccountAddress`

Note, using the `--raw` flag with the command will sign plaintext messages as bytes rather than [Aleo](https://developer.aleo.org/aleo/language#data-types-and-values) values such as `1u8` or `100field`.
Note, using the `--raw` flag with the command will sign plaintext messages as bytes rather than [Aleo](https://developer.aleo.org/aleo/language#data-types-and-values) values such as `1u8` or `100field`.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Alternatively, you can install `snarkvm` by building from the source code as fol

```bash
# Download the source code
git clone https://github.com/AleoHQ/snarkvm && cd snarkvm
git clone https://github.com/ProvableHQ/snarkvm && cd snarkvm

# Install snarkVM
$ cargo install --path .
Expand Down Expand Up @@ -148,4 +148,3 @@ To update snarkVM and suppress outputs to terminal run:
```
snarkvm update --quiet
```

6 changes: 3 additions & 3 deletions documentation/00_aleo_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Aleo instructions are compiled into AVM opcodes that can be executed by the Aleo
Install snarkVM to compile and execute Aleo instructions.

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

## Installing snarkVM
Expand All @@ -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/AleoHQ/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 All @@ -53,4 +53,4 @@ The snarkVM CLI provides a suite of commands to make programming in Aleo instruc

## Additional Material

Install Aleo instructions for your favorite code [**editor**](./aleo/07_tooling.md).
Install Aleo instructions for your favorite code [**editor**](./aleo/07_tooling.md).
8 changes: 4 additions & 4 deletions documentation/00_getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ performant, secure, and private. Aleo introduces an application runtime environm
to compile, execute, and finalize its state autonomously.

:::tip
# What's new on Aleo?
# 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-leo-app/01_create_leo_app.md) - A full stack application written in Typescript using Leo and React.
Expand All @@ -33,10 +33,10 @@ to compile, execute, and finalize its state autonomously.
### 1.3 Install Leo

```bash
curl -L https://raw.githubusercontent.com/AleoHQ/workshop/master/install.sh | sh
curl -L https://raw.githubusercontent.com/AleoHQ/workshop/master/install.sh | sh
emlazzarin marked this conversation as resolved.
Show resolved Hide resolved
```

Learning Leo is the fastest way to develop private applications on Aleo.
Learning Leo is the fastest way to develop private applications on Aleo.

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

Expand Down Expand Up @@ -76,7 +76,7 @@ If you're interested in learning more about Aleo:

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

🐙 | GitHub ~ **https://github.com/AleoHQ**
🐙 | GitHub ~ **https://github.com/ProvableHQ**

📄 | Developer Documentation ~ **https://developer.aleo.org/**

Expand Down
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/08_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/07_resources.md#style-guide) and [**Common Patterns**](./leo/07_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/07_resources.md#contributing) for more information.

Expand Down
10 changes: 5 additions & 5 deletions documentation/00_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ An index of all pages available in this documentation.
### Chapter 2: Leo by Example

- [Auction](./leo/09_auction.md)
- [Basic Bank](https://github.com/AleoHQ/workshop/tree/master/basic_bank)
- [Vote](https://github.com/AleoHQ/workshop/tree/master/vote)
- [Token](https://github.com/AleoHQ/workshop/tree/master/token)
- [TicTacToe](https://github.com/AleoHQ/workshop/tree/master/tictactoe)
- [Battleship](https://github.com/AleoHQ/workshop/tree/master/battleship)
- [Basic Bank](https://github.com/ProvableHQ/workshop/tree/master/basic_bank)
- [Vote](https://github.com/ProvableHQ/workshop/tree/master/vote)
- [Token](https://github.com/ProvableHQ/workshop/tree/master/token)
- [TicTacToe](https://github.com/ProvableHQ/workshop/tree/master/tictactoe)
- [Battleship](https://github.com/ProvableHQ/workshop/tree/master/battleship)

### Chapter 3: Aleo Instructions

Expand Down
Loading