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 Oct 4, 2024
1 parent 2e858c5 commit eba4cf3
Show file tree
Hide file tree
Showing 9 changed files with 107 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ This repository serves as a guide for getting started with building on Aleo. Her
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
- [🧰 Provable SDK](https://provable.tools/) - A Software Development Kit (SDK) for Zero-Knowledge Transactions.
- [🔭 Aleo Explorer](https://aleo.network) - Validate and broadcast on Aleo Testnet III
=======
Expand All @@ -37,6 +38,8 @@ This repository serves as a guide for getting started with building on Aleo. Her
=======
=======
>>>>>>> 5ab53f8 (Fix explorer link and remove usage of testnet3)
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
- [🧰 Aleo SDK](https://provable.tools/) - A Software Development Kit (SDK) for Zero-Knowledge Transactions.
- [🔭 Aleo Explorer](https://explorer.aleo.org) - Validate and broadcast on Aleo Testnet Beta
=======
Expand All @@ -47,14 +50,26 @@ This repository serves as a guide for getting started with building on Aleo. Her
>>>>>>> 88fc9fe (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
=======
=======
=======
>>>>>>> 7481292 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
- [🧰 Provable SDK](https://provable.tools/) - A Software Development Kit (SDK) for Zero-Knowledge Transactions.
- [🔭 Aleo Explorer](https://aleo.network) - Validate and broadcast on Aleo Testnet III
=======
- [🧰 Aleo SDK](https://provable.tools/) - A Software Development Kit (SDK) for Zero-Knowledge Transactions.
- [🔭 Aleo Explorer](https://explorer.aleo.org) - Validate and broadcast on Aleo Testnet Beta
>>>>>>> be2a7dd (Fix explorer link and remove usage of testnet3)
<<<<<<< HEAD
>>>>>>> 16d016d (Fix explorer link and remove usage of testnet3)
<<<<<<< HEAD
>>>>>>> 5ab53f8 (Fix explorer link and remove usage of testnet3)
=======
=======
=======
- [🧰 Provable SDK](https://provable.tools/) - A Software Development Kit (SDK) for Zero-Knowledge Transactions.
- [🔭 Aleo Explorer](https://aleo.network) - Validate and broadcast on Aleo Testnet III
>>>>>>> ebee403 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> 7481292 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
For help setting up, join us on [Discord](https://discord.com/invite/aleo) to ask questions and help others answer their questions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,17 @@ This process enables users to securely and privately transfer data and values ac
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
=======
>>>>>>> e45966b (docs: update url AleoHQ -> AleoNet)
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
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/circuit/program/src/data/record/encrypt.rs) and [decrypt](https://github.com/AleoNet/snarkVM/blob/mainnet/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/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.
>>>>>>> a5c06be (docs: update url AleoHQ -> AleoNet)
<<<<<<< HEAD
<<<<<<< HEAD
=======
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.
>>>>>>> ee9c63b (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
Expand All @@ -105,6 +109,11 @@ The code for encryption and decryption is available in the snarkVM sections, whi
>>>>>>> be2a7dd (Fix explorer link and remove usage of testnet3)
=======
>>>>>>> e45966b (docs: update url AleoHQ -> AleoNet)
=======
=======
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.
>>>>>>> ee9c63b (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
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
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Besides requiring ProverSolutions to be valid, the network also demands that the
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
Becoming a Prover node does not require staking or authorization, anyone can [start a Prover node](https://github.com/AleoNet/snarkOS?tab=readme-ov-file#32-run-an-aleo-prover).
=======
<<<<<<< HEAD
Expand All @@ -50,6 +51,8 @@ Becoming a Prover node does not require staking or authorization, anyone can [st
=======
=======
>>>>>>> e45966b (docs: update url AleoHQ -> AleoNet)
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
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/AleoNet/snarkOS?tab=readme-ov-file#32-run-an-aleo-prover).
Expand All @@ -58,6 +61,8 @@ Becoming a Prover node does not require staking or authorization, anyone can [st
>>>>>>> 5ab53f8 (Fix explorer link and remove usage of testnet3)
=======
=======
=======
>>>>>>> 7481292 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
Becoming a Prover node does not require staking or authorization, anyone can [start a Prover node](https://github.com/AleoNet/snarkOS?tab=readme-ov-file#32-run-an-aleo-prover).
=======
<<<<<<< HEAD
Expand All @@ -66,5 +71,14 @@ Becoming a Prover node does not require staking or authorization, anyone can [st
Becoming a Prover node does not require staking or authorization, anyone can [start a Prover node](https://github.com/AleoNet/snarkOS?tab=readme-ov-file#32-run-an-aleo-prover).
>>>>>>> a5c06be (docs: update url AleoHQ -> AleoNet)
>>>>>>> 3439f50 (docs: update url AleoHQ -> AleoNet)
<<<<<<< HEAD
>>>>>>> 73c6360 (docs: update url AleoHQ -> AleoNet)
<<<<<<< HEAD
>>>>>>> e45966b (docs: update url AleoHQ -> AleoNet)
=======
=======
=======
Becoming a Prover node does not require staking or authorization, anyone can [start a Prover node](https://github.com/AleoNet/snarkOS?tab=readme-ov-file#32-run-an-aleo-prover).
>>>>>>> ebee403 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> 7481292 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
4 changes: 4 additions & 0 deletions documentation/00_sdk_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ The official Provable SDK providing Javascript/Typescript tools for creating zer
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.

<<<<<<< HEAD
#### Source: [`sdk/sdk`](https://github.com/provablehq/sdk/tree/testnet3/sdk)
=======
#### Source: [`sdk/sdk`](https://github.com/provablehq/sdk/tree//sdk)
>>>>>>> ebee403 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)

## 2. [Create-Leo-App](./sdk/create-leo-app/00_app_installation.md) - Zero Knowledge Web App Examples
Expand Down
6 changes: 6 additions & 0 deletions documentation/aleo/07_tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,22 @@ Download the editor here: https://code.visualstudio.com/download.
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
1. Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from VSCode marketplace.
=======
1. Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=provablehq.leo-extension) from VSCode marketplace.
>>>>>>> ebee403 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
<<<<<<< HEAD
=======
1. Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=provablehq.leo-extension) from VSCode marketplace.
>>>>>>> 88fc9fe (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
=======
1. Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from VSCode marketplace.
>>>>>>> 00016dd (docs: fix errors from ci)
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
2. The correct extension ID is `provablehq.leo-extension`, and the description should state "the official VSCode extension for Leo".

### Usage
Expand Down
19 changes: 19 additions & 0 deletions documentation/concepts/00_accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ Given global instantiated Aleo parameters and subroutines.
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
[source code](https://github.com/AleoNet/snarkVM/blob/mainnet-staging/console/account/src/private_key/try_from.rs)
=======
[source code](https://github.com/AleoNet/snarkVM/blob/mainnet/console/account/src/private_key/try_from.rs)
Expand All @@ -180,6 +181,8 @@ Given global instantiated Aleo parameters and subroutines.
>>>>>>> 5ab53f8 (Fix explorer link and remove usage of testnet3)
=======
>>>>>>> e45966b (docs: update url AleoHQ -> AleoNet)
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
[source code](https://github.com/AleoNet/snarkVM/blob/mainnet/console/account/src/private_key/try_from.rs)
=======
[source code](https://github.com/AleoNet/snarkVM/blob/testnet3/console/account/src/private_key/try_from.rs)
Expand Down Expand Up @@ -211,6 +214,8 @@ Given global instantiated Aleo parameters and subroutines.
=======
=======
>>>>>>> 73c6360 (docs: update url AleoHQ -> AleoNet)
=======
>>>>>>> 7481292 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
[source code](https://github.com/AleoNet/snarkVM/blob/mainnet-staging/console/account/src/private_key/try_from.rs)
=======
[source code](https://github.com/AleoNet/snarkVM/blob/mainnet/console/account/src/private_key/try_from.rs)
Expand All @@ -222,13 +227,27 @@ Given global instantiated Aleo parameters and subroutines.
=======
=======
=======
=======
>>>>>>> ebee403 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
[source code](https://github.com/AleoNet/snarkVM/blob/mainnet/console/account/src/private_key/try_from.rs)
=======
[source code](https://github.com/AleoNet/snarkVM/blob/testnet3/console/account/src/private_key/try_from.rs)
>>>>>>> a5c06be (docs: update url AleoHQ -> AleoNet)
<<<<<<< HEAD
>>>>>>> 3439f50 (docs: update url AleoHQ -> AleoNet)
<<<<<<< HEAD
>>>>>>> 73c6360 (docs: update url AleoHQ -> AleoNet)
<<<<<<< HEAD
>>>>>>> e45966b (docs: update url AleoHQ -> AleoNet)
=======
=======
=======
=======
[source code](https://github.com/AleoNet/snarkVM/blob/mainnet-staging/console/account/src/private_key/try_from.rs)
>>>>>>> ee9c63b (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> ebee403 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> 7481292 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
#### Generate a View Key
1. `(sk_sig, r_sig)` = `private_key`
Expand Down
7 changes: 7 additions & 0 deletions documentation/sdk/create-leo-app/01_create_leo_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,13 @@ Note down your transaction ID in the back of the URL from the faucet. The succes
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
=======
>>>>>>> 5ab53f8 (Fix explorer link and remove usage of testnet3)
=======
>>>>>>> 21d9a55 (update explorer and api urls)
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
Transfer successful! for message ID: 1156693507768078496
https://api.explorer.provable.com/v1/testnet/transaction/at12u62xwfew2rq32xee8nwhtlxghfjz7mm3528yj240nuezue625fqy4lhlp
=======
Expand All @@ -117,6 +120,7 @@ have fun https://explorer.provable.com/transaction/...
=======
Transfer successful! for message ID: 1156693507768078496
https://api.explorer.provable.com/v1/testnet/transaction/at12u62xwfew2rq32xee8nwhtlxghfjz7mm3528yj240nuezue625fqy4lhlp
<<<<<<< HEAD
>>>>>>> 88fc9fe (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
=======
>>>>>>> 5ab53f8 (Fix explorer link and remove usage of testnet3)
Expand All @@ -125,6 +129,9 @@ https://api.explorer.provable.com/v1/testnet/transaction/at12u62xwfew2rq32xee8nw
have fun https://explorer.provable.com/transaction/...
>>>>>>> b9cb75a (update explorer and api urls)
>>>>>>> 21d9a55 (update explorer and api urls)
=======
>>>>>>> ebee403 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
```

### Leo & `helloworld`
Expand Down
6 changes: 6 additions & 0 deletions documentation/sdk/wasm/00_wasm_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ sidebar_label: Installation
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
<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>
=======
Expand All @@ -19,6 +22,7 @@ sidebar_label: Installation
<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>
>>>>>>> ebee403 (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
<<<<<<< HEAD
=======
<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>
Expand All @@ -27,6 +31,8 @@ sidebar_label: Installation
<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>
>>>>>>> 88fc9fe (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
=======
>>>>>>> 521485c (docs: update API endpoint, links to sdk and rename testnet3 to testnet)
<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/provablehq/sdk)&ensp;[![crates-io]](https://crates.io/crates/aleo-wasm)&ensp;[![docs-rs]](https://docs.rs/aleo-wasm/latest/aleo-wasm/)
Expand Down
Loading

0 comments on commit eba4cf3

Please sign in to comment.