From 158c1049fe795166cced4d3ea08dfa96cb84c109 Mon Sep 17 00:00:00 2001 From: Jake Tarnow Date: Mon, 29 Jul 2024 11:15:20 -0700 Subject: [PATCH 1/4] update API and SDK docs --- documentation/00_overview.md | 4 +- documentation/00_sdk_overview.md | 18 +- .../testnet/getting_started/00_overview.md | 28 +-- .../getting_started/01_installation.md | 164 ++++++++++++++---- .../getting_started/02_deploy_and_execute.md | 22 ++- .../03_deploy_and_execute_demo.md | 16 +- .../getting_started/04_developer_toolkit.md | 4 +- .../public_endpoints/00_latest_height.md | 2 +- .../public_endpoints/01_latest_hash.md | 2 +- .../public_endpoints/02_latest_block.md | 2 +- .../public_endpoints/03_latest_state_root.md | 2 +- .../testnet/public_endpoints/04_get_block.md | 2 +- .../testnet/public_endpoints/05_get_blocks.md | 2 +- .../testnet/public_endpoints/06_get_height.md | 2 +- .../07_get_block_transactions.md | 2 +- .../public_endpoints/08_get_transaction.md | 2 +- .../09_get_memory_pool_transactions.md | 2 +- .../public_endpoints/10_get_program.md | 2 +- .../public_endpoints/11_get_mapping_names.md | 2 +- .../public_endpoints/12_get_mapping_value.md | 2 +- .../13_get_state_path_for_commitment.md | 2 +- .../public_endpoints/14_get_beacons.md | 21 --- .../public_endpoints/14_get_committee.md | 21 +++ .../public_endpoints/15_get_peers_count.md | 2 +- .../public_endpoints/16_get_peers_all.md | 2 +- .../17_get_peers_all_metrics.md | 2 +- .../public_endpoints/18_get_node_address.md | 2 +- .../public_endpoints/19_find_block_hash.md | 2 +- .../20_find_transaction_id_from_program_id.md | 2 +- ..._find_transaction_id_from_transition_id.md | 2 +- .../public_endpoints/22_find_transition_id.md | 2 +- .../public_endpoints/23_get_env_info.md | 2 +- .../24_transaction_broadcast.md | 2 +- 33 files changed, 220 insertions(+), 126 deletions(-) delete mode 100644 documentation/testnet/public_endpoints/14_get_beacons.md create mode 100644 documentation/testnet/public_endpoints/14_get_committee.md diff --git a/documentation/00_overview.md b/documentation/00_overview.md index 8dc3f2e797..12ebdf31b3 100644 --- a/documentation/00_overview.md +++ b/documentation/00_overview.md @@ -55,7 +55,7 @@ An index of all pages available in this documentation. - [Aleo Instructions Grammar](./aleo/06_grammar.md) - [Aleo Instructions Code Editor Plugins](./aleo/07_tooling.md) -## Testnet III +## Testnet ### Chapter 5: Getting Started @@ -77,7 +77,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) - [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) diff --git a/documentation/00_sdk_overview.md b/documentation/00_sdk_overview.md index c69a8ca0d7..f50de30eba 100644 --- a/documentation/00_sdk_overview.md +++ b/documentation/00_sdk_overview.md @@ -5,7 +5,7 @@ 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://aleo.tools/account) 2. [Web-based program execution and deployment](https://aleo.tools/develop) @@ -13,14 +13,14 @@ several TypeScript & JavaScript libraries which provide the following functional 4. [Management of program state and data](https://aleo.tools/record) 5. [Communication with the Aleo network](https://aleo.tools/rest) -All of this functionality is demonstrated on [Aleo.tools](https://aleo.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 - Aleo SDK + Aleo SDK The official Aleo SDK providing Javascript/Typescript tools for creating zero knowledge apps. @@ -33,7 +33,7 @@ first zero knowledge web app. #### Source: [`sdk/sdk`](https://github.com/AleoHQ/sdk/tree/testnet3/sdk) -## 2. [Create-Aleo-App](./sdk/create-aleo-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 Create Aleo App @@ -48,11 +48,11 @@ You can start with a template by running npm create aleo-app@latest ``` -#### Source: [`sdk/create-aleo-app`](https://github.com/AleoHQ/sdk/tree/testnet3/create-aleo-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 - Create Aleo App + Create Aleo App Create Aleo App Aleo-Wasm @@ -61,7 +61,7 @@ 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 @@ -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 diff --git a/documentation/testnet/getting_started/00_overview.md b/documentation/testnet/getting_started/00_overview.md index bdc821debd..6aad2d1b07 100644 --- a/documentation/testnet/getting_started/00_overview.md +++ b/documentation/testnet/getting_started/00_overview.md @@ -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 @@ -24,16 +24,16 @@ 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. | 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: @@ -41,10 +41,10 @@ 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. @@ -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: @@ -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 Beacons](../public_endpoints/14_get_committee) - [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) diff --git a/documentation/testnet/getting_started/01_installation.md b/documentation/testnet/getting_started/01_installation.md index f666abe300..f730912339 100644 --- a/documentation/testnet/getting_started/01_installation.md +++ b/documentation/testnet/getting_started/01_installation.md @@ -39,21 +39,21 @@ The following are **minimum** requirements to run an Aleo node: - Provers: Ubuntu 20.04, macOS Ventura or later - Validators: Ubuntu 20.04 - **CPU**: 64-bit architectures only - - Clients: 16-cores + - Clients: 32-cores - Provers: 32-cores (64-cores preferred) - Validators: 32-cores (64-cores preferred) - **RAM**: DDR4 or better - - Clients: 16GB of memory + - Clients: 32GB of memory - Provers: 32GB of memory (64GB or larger preferred) - Validators: 64GB of memory (128GB or larger preferred) - **Storage**: PCIe Gen 3 x4, PCIe Gen 4 x2 NVME SSD, or better - - Clients: 64GB of disk space - - Provers: 128GB of disk space + - Clients: 300GB of disk space + - Provers: 32GB of disk space - Validators: 2TB of disk space (4TB or larger preferred) - **Network**: Symmetric, commercial, always-on - Clients: 100Mbps of upload **and** download bandwidth - - Provers: 250Mbps of upload **and** download bandwidth - - Validators: 500Mbps of upload **and** download bandwidth + - Provers: 500Mbps of upload **and** download bandwidth + - Validators: 1000Mbps of upload **and** download bandwidth - **GPU**: - Clients: Not required at this time - Provers: CUDA-enabled GPU (optional) @@ -63,7 +63,7 @@ Please note to run an Aleo Prover that is **competitive**, the machine will requ ### 2.2 Installation -Before beginning, please ensure your machine has `Rust v1.66+` installed. Instructions to [install Rust can be found here.](https://www.rust-lang.org/tools/install) +Before beginning, please ensure your machine has `Rust v1.76+` installed. Instructions to [install Rust can be found here.](https://www.rust-lang.org/tools/install) Start by cloning this Github repository: ``` @@ -85,7 +85,7 @@ Lastly, install `snarkOS`: cargo install --path . ``` -Please ensure ports `4133/tcp` and `3033/tcp` are open on your router and OS firewall. +Please ensure ports `4130/tcp` and `3030/tcp` are open on your router and OS firewall. ## 3. Run an Aleo Node @@ -137,7 +137,7 @@ APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ### 2. My node is unable to connect to peers on the network. -- Ensure ports `4133/tcp` and `3033/tcp` are open on your router and OS firewall. +- Ensure ports `4130/tcp` and `3030/tcp` are open on your router and OS firewall. - Ensure `snarkOS` is started using `./run-client.sh` or `./run-prover.sh`. ### 3. I can't generate a new address ### @@ -175,42 +175,51 @@ USAGE: snarkos start [OPTIONS] OPTIONS: - --network Specify the network ID of this node [default: 3] + --network Specify the network ID of this node [default: 3] - --beacon Specify this node as a beacon, with the account private key as an argument - --validator Specify this node as a validator, with the account private key as an argument - --prover Specify this node as a prover, with the given account private key as an argument - --client Specify this node as a client, with an optional account private key as an argument + --validator Specify this node as a validator + --prover Specify this node as a prover + --client Specify this node as a client - --node Specify the IP address and port for the node server [default: 0.0.0.0:4133] - --connect Specify the IP address and port of a peer to connect to + --private-key Specify the node's account private key + --private-key-file Specify the path to a file containing the node's account private key - --rest Specify the IP address and port for the REST server [default: 0.0.0.0:3033] - --norest If the flag is set, the node will not initialize the REST server + --node Specify the IP address and port for the node server [default: 0.0.0.0:4130] + --connect Specify the IP address and port of a peer to connect to + + --rest Specify the IP address and port for the REST server [default: 0.0.0.0:3030] + --norest If the flag is set, the node will not initialize the REST server - --nodisplay If the flag is set, the node will not render the display - --verbosity Specify the verbosity of the node [options: 0, 1, 2, 3] [default: 2] - --logfile Specify the path to the file where logs will be stored [default: /tmp/snarkos.log] + --nodisplay If the flag is set, the node will not render the display + --verbosity Specify the verbosity of the node [options: 0, 1, 2, 3] [default: 2] + --logfile Specify the path to the file where logs will be stored [default: /tmp/snarkos.log] - --dev Enables development mode, specify a unique ID for this node - -h, --help Print help information + --dev Enables development mode, specify a unique ID for this node + -h, --help Print help information ``` ## 6. Development ### 6.1 Quick Start -In one terminal, start the beacon by running: +In the first terminal, start the first validator by running: ``` -cargo run --release -- start --nodisplay --dev 0 --beacon "" +cargo run --release -- start --nodisplay --dev 0 --validator ``` - -In a second terminal, run: +In the second terminal, start the second validator by running: +``` +cargo run --release -- start --nodisplay --dev 1 --validator +``` +In the third terminal, start the third validator by running: ``` -cargo run --release -- start --nodisplay --dev 1 --prover "" +cargo run --release -- start --nodisplay --dev 2 --validator +``` +In the fourth terminal, start the fourth validator by running: +``` +cargo run --release -- start --nodisplay --dev 3 --validator ``` -This procedure can be repeated to start more nodes. +From here, this procedure can be used to further start-up provers and clients. ### 6.2 Operations @@ -218,16 +227,103 @@ It is important to initialize the nodes starting from `0` and incrementing by `1 The following is a list of options to initialize a node (replace `` with a number starting from `0`): ``` -cargo run --release -- start --nodisplay --dev --beacon "" -cargo run --release -- start --nodisplay --dev --validator "" -cargo run --release -- start --nodisplay --dev --prover "" -cargo run --release -- start --nodisplay --dev --client "" +cargo run --release -- start --nodisplay --dev --validator +cargo run --release -- start --nodisplay --dev --prover +cargo run --release -- start --nodisplay --dev --client cargo run --release -- start --nodisplay --dev ``` When no node type is specified, the node will default to `--client`. -##### Clean Up +### 6.3 Local Devnet + +#### 6.3.1 Install `tmux` + +To run a local devnet with the script, start by installing `tmux`. + +
macOS + +To install `tmux` on macOS, you can use the `Homebrew` package manager. +If you haven't installed `Homebrew` yet, you can find instructions at [their website](https://brew.sh/). +```bash +# Once Homebrew is installed, run: +brew install tmux +``` + +
+ +
Ubuntu + +On Ubuntu and other Debian-based systems, you can use the `apt` package manager: +```bash +sudo apt update +sudo apt install tmux +``` + +
+ +
Windows + +There are a couple of ways to use `tmux` on Windows: + +### Using Windows Subsystem for Linux (WSL) + +1. First, install [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install). +2. Once WSL is set up and you have a Linux distribution installed (e.g., Ubuntu), open your WSL terminal and install `tmux` as you would on a native Linux system: +```bash +sudo apt update +sudo apt install tmux +``` + +
+ +#### 6.3.2 Start a Local Devnet + +To start a local devnet, run: +``` +./devnet.sh +``` +Follow the instructions in the terminal to start the devnet. + +#### 6.3.3 View a Local Devnet + +#### Switch Nodes (forward) + +To toggle to the next node in a local devnet, run: +``` +Ctrl+b n +``` + +#### Switch Nodes (backwards) + +To toggle to the previous node in a local devnet, run: +``` +Ctrl+b p +``` + +#### Select a Node (choose-tree) + +To select a node in a local devnet, run: +``` +Ctrl+b w +``` + +#### Select a Node (manually) + +To select a node manually in a local devnet, run: +``` +Ctrl+b :select-window -t {NODE_ID} +``` + +#### 6.3.4 Stop a Local Devnet + +To stop a local devnet, run: +``` +Ctrl+b :kill-session +``` +Then, press `Enter`. + +### Clean Up To clean up the node storage, run: ``` diff --git a/documentation/testnet/getting_started/02_deploy_and_execute.md b/documentation/testnet/getting_started/02_deploy_and_execute.md index d453a868e2..98c9e6d539 100644 --- a/documentation/testnet/getting_started/02_deploy_and_execute.md +++ b/documentation/testnet/getting_started/02_deploy_and_execute.md @@ -24,14 +24,14 @@ These CLI commands currently live in snarkOS, but can also be migrated to the Al ``` git clone https://github.com/AleoHQ/snarkOS.git cd snarkOS -git checkout testnet3 +git checkout mainnet-staging cargo install --path . ``` ### 2. Run the node in development mode ``` -snarkos start --nodisplay --dev 0 --beacon "" +snarkos start --nodisplay --dev ``` ### 3. Scan the node for spendable records @@ -44,18 +44,16 @@ snarkos developer scan -v --start 0 --end 1 --endpoint "http://localh ### 4. Transfer credits (execute the `credits.aleo` program) -Transfer credits to another account so it can't be spent by the beacon producing blocks. - -(The beacon is constantly spending records to generate new blocks, so there is a chance your record is spent before doing this step) +Transfer credits to another account. ``` -snarkos developer execute credits.aleo transfer "u64" --private-key --query "http://localhost:3030" --broadcast "http://localhost:3030/testnet3/transaction/broadcast" +snarkos developer execute credits.aleo transfer "u64" --private-key --query "http://localhost:3030" --broadcast "http://localhost:3030/testnet/transaction/broadcast" ``` or ``` -snarkos developer transfer --input-record --recipient --private-key --query "" --broadcast "" +snarkos developer transfer --input-record --recipient --private-key --query "" --broadcast "" ``` This step can be replaced with a faucet. @@ -66,14 +64,14 @@ Deploy a program with an unspent record. ``` -snarkos developer deploy fibonacci.aleo --private-key --query "http://localhost:3030" --path "../leo/examples/fibonacci/build/" --broadcast "http://localhost:3030/testnet3/transaction/broadcast" --fee 600000 --record +snarkos developer deploy fibonacci.aleo --private-key --query "http://localhost:3030" --path "../leo/examples/fibonacci/build/" --broadcast "http://localhost:3030/testnet/transaction/broadcast" --fee 600000 --record ``` ### 6. Execute a function of a deployed program ``` -snarkos developer execute fibonacci.aleo fibonacci "1u8" --private-key --query "http://localhost:3030" --broadcast "http://localhost:3030/testnet3/transaction/broadcast" +snarkos developer execute fibonacci.aleo fibonacci "1u8" --private-key --query "http://localhost:3030" --broadcast "http://localhost:3030/testnet/transaction/broadcast" ``` *NOTE: Fees (in microcredits) must be greater than the transaction size in bytes. Fees can be excluded from execution transactions, but if one is specified, it must follow the above rule. * @@ -122,7 +120,7 @@ Create an Aleo program deployment. ##### Example: ``` -snarkos developer deploy fibonacci.aleo --private-key --query "http://localhost:3030" --path "./leo/examples/fibonacci/build/" --broadcast "http://localhost:3030/testnet3/transaction/broadcast" --fee 550000 --record +snarkos developer deploy fibonacci.aleo --private-key --query "http://localhost:3030" --path "./leo/examples/fibonacci/build/" --broadcast "http://localhost:3030/testnet/transaction/broadcast" --fee 550000 --record ``` ### Execute @@ -152,7 +150,7 @@ Create an Aleo program execution. ##### Example: ``` -snarkos developer execute fibonacci.aleo fibonacci "1u8" --private-key --query "http://localhost:3030" --broadcast "http://localhost:3030/testnet3/transaction/broadcast" +snarkos developer execute fibonacci.aleo fibonacci "1u8" --private-key --query "http://localhost:3030" --broadcast "http://localhost:3030/testnet/transaction/broadcast" ``` ### Scan @@ -203,7 +201,7 @@ Transfer credits with a `credits.aleo` program execution. ##### Example: ``` -snarkos developer transfer --input-record --recipient --private-key --query "" --broadcast "" +snarkos developer transfer --input-record --recipient --private-key --query "" --broadcast "" ``` diff --git a/documentation/testnet/getting_started/03_deploy_and_execute_demo.md b/documentation/testnet/getting_started/03_deploy_and_execute_demo.md index 166304722c..c937d172eb 100644 --- a/documentation/testnet/getting_started/03_deploy_and_execute_demo.md +++ b/documentation/testnet/getting_started/03_deploy_and_execute_demo.md @@ -26,12 +26,12 @@ Make sure you have both Leo and snarkOS installed on your machine. **Note**: -* You can find instructions to install Leo on your machine [here](https://github.com/AleoHQ/leo) and snarkOS [here](https://github.com/AleoHQ/snarkos) +* You can find instructions to install Leo on your machine [here](https://github.com/ProvableHQ/leo) and snarkOS [here](https://github.com/AleoHQ/snarkos) * Make sure to pull the latest versions of `snarkos` and `leo` from GitHub to your local machine ### 2. Generate your test keys and wallet address -* In your favorite browser, navigate to [https://aleo.tools/](https://aleo.tools/) and click the **Generate** button +* In your favorite browser, navigate to [provable.tools](https://www.provable.tools/) and click the **Generate** button * Save your **Address**, **View Key**, and **Private Key** in a safe place, you'll need them later ### 3a. Seeding your wallet with credits @@ -106,7 +106,7 @@ Alternatively, you can find your execute transaction confirmation by going to [t ### 5. Obtain your records plaintext -* Navigate to [https://aleo.tools/](https://aleo.tools/) and click the **Record** tab in the nav bar at the top of the page +* Navigate to [provable.tools](https://www.provable.tools/) and click the **Record** tab in the nav bar at the top of the page * Place the record ciphertext you copied in the previous step in the `Record (Ciphertext)` field * Place your view key in the `View Key` field * Copy the plaintext record provided. If you do not see it, it's likely you copied the wrong ciphertext record in step 4. Consider revisiting or reach out to `hello@aleo.org`. @@ -139,7 +139,7 @@ RECORD="" * Deploy your Leo application (if all your variables were assigned correctly, you should be able to copy/paste the following ``` -snarkos developer deploy "${APPNAME}.aleo" --private-key "${PRIVATEKEY}" --query "https://api.explorer.aleo.org/v1" --path "./${APPNAME}/build/" --broadcast "https://api.explorer.aleo.org/v1/testnet3/transaction/broadcast" --fee 1000000 --record "${RECORD}" +snarkos developer deploy "${APPNAME}.aleo" --private-key "${PRIVATEKEY}" --query "https://api.explorer.aleo.org/v1" --path "./${APPNAME}/build/" --broadcast "https://api.explorer.aleo.org/v1/testnet/transaction/broadcast" --fee 1000000 --record "${RECORD}" ``` You should have seen a confirmation that your Aleo application was deployed in the form of a transaction ID that looks like the following `at1rkkpqu5k4rt86zzccczw6cxeyvrl7hxydvvv7dhl7zr7p9w40c8s70kwm8`. Make sure to copy this string as you'll need it for the last step. @@ -149,9 +149,9 @@ You should have seen a confirmation that your Aleo application was deployed in t Finally, it is time to execute the application you just deployed! -* You'll need to update the `--record` flag with the latest transaction linked to your wallet balance. In this case, you can obtain that by going to the following URL: https://api.explorer.aleo.org/v1/testnet3/transaction/$DEPLOY_TX_ID but replace $DEPLOY_TX_ID with the transaction ID provided to you once your application was deployed (or from the most recent transaction linked to your wallet address). An example URL looks like so: https://api.explorer.aleo.org/v1/testnet3/transaction/at1rkkpqu5k4rt86zzccczw6cxeyvrl7hxydvvv7dhl7zr7p9w40c8s70kwm8 -* In the JSON object provided at https://api.explorer.aleo.org/v1/testnet3/transaction/$DEPLOY_TX_ID, navigate to: `object.fee.transition.outputs[0].value` and copy the record ciphertext value. -* Head to [aleo.tools](https://aleo.tools/) and navigate to the **Record** tab and paste the record ciphertext you just copied as well as your wallet's view key +* You'll need to update the `--record` flag with the latest transaction linked to your wallet balance. In this case, you can obtain that by going to the following URL: https://api.explorer.aleo.org/v1/testnet/transaction/$DEPLOY_TX_ID but replace $DEPLOY_TX_ID with the transaction ID provided to you once your application was deployed (or from the most recent transaction linked to your wallet address). An example URL looks like so: https://api.explorer.aleo.org/v1/testnet/transaction/at1rkkpqu5k4rt86zzccczw6cxeyvrl7hxydvvv7dhl7zr7p9w40c8s70kwm8 +* In the JSON object provided at https://api.explorer.aleo.org/v1/testnet/transaction/$DEPLOY_TX_ID, navigate to: `object.fee.transition.outputs[0].value` and copy the record ciphertext value. +* Head to [provable.tools](https://www.provable.tools/) and navigate to the **Record** tab and paste the record ciphertext you just copied as well as your wallet's view key * Similar to the steps we followed for a deploy transaction, update your `RECORD` variable with the record plaintext you just decrypted by doing the following: @@ -165,7 +165,7 @@ RECORD="" Then just paste the following command in your terminal ``` -snarkos developer execute "${APPNAME}.aleo" "main" "1u32" "2u32" --private-key "${PRIVATEKEY}" --query "https://api.explorer.aleo.org/v1" --broadcast "https://api.explorer.aleo.org/v1/testnet3/transaction/broadcast" --fee 1000000 --record "${RECORD}" +snarkos developer execute "${APPNAME}.aleo" "main" "1u32" "2u32" --private-key "${PRIVATEKEY}" --query "https://api.explorer.aleo.org/v1" --broadcast "https://api.explorer.aleo.org/v1/testnet/transaction/broadcast" --fee 1000000 --record "${RECORD}" ``` Awesome! You have successfully deployed and executed a Leo application to Testnet III, how exciting 🎉 diff --git a/documentation/testnet/getting_started/04_developer_toolkit.md b/documentation/testnet/getting_started/04_developer_toolkit.md index 4be430ac88..85057124e0 100644 --- a/documentation/testnet/getting_started/04_developer_toolkit.md +++ b/documentation/testnet/getting_started/04_developer_toolkit.md @@ -8,7 +8,7 @@ This toolkit works best with a MacOS machine from 2021 or newer. You can check y ## Leo ### Download and install Leo -- You can find the latest version of Leo [here](https://github.com/AleoHQ/leo/releases/latest). +- You can find the latest version of Leo [here](https://github.com/ProvableHQ/leo/releases/latest). - After downloading the version that works for your machine, double-click the zip file to open it. - Then install Leo by moving it to `/usr/local/bin` on your machine, which you can do by dragging it to that location or via terminal (`sudo mv leo /usr/local/bin`); in both cases, you will need to enter your computer password. @@ -140,7 +140,7 @@ This section refers to the guide created by GitHub [here](https://docs.github.co Check out the following resources: - [Our developer docs](https://developer.aleo.org/getting_started/) -- See Aleo's SDK in action at [aleo.tools](https://aleo.tools) +- See the SDK in action at [provable.tools](https://www.provable.tools/) - Play around with Leo in the browser with [Leo Playground](https://play.leo-lang.org/) - Learn Leo syntax, functions, and best practices with the [Leo's language guide](https://developer.aleo.org/leo/language) - Deploy and Execute Leo applications on-chain with our [Deploy and Execute Demo](https://developer.aleo.org/testnet/getting_started/deploy_execute_demo) diff --git a/documentation/testnet/public_endpoints/00_latest_height.md b/documentation/testnet/public_endpoints/00_latest_height.md index 146155b105..cfec8fbadb 100644 --- a/documentation/testnet/public_endpoints/00_latest_height.md +++ b/documentation/testnet/public_endpoints/00_latest_height.md @@ -5,7 +5,7 @@ sidebar_label: Latest Height --- ```bash title=ENDPOINT -GET /testnet3/latest/height +GET /testnet/latest/height ``` Returns the latest block height. diff --git a/documentation/testnet/public_endpoints/01_latest_hash.md b/documentation/testnet/public_endpoints/01_latest_hash.md index f4b157372b..8b5ae81c95 100644 --- a/documentation/testnet/public_endpoints/01_latest_hash.md +++ b/documentation/testnet/public_endpoints/01_latest_hash.md @@ -5,7 +5,7 @@ sidebar_label: Latest Hash --- ```bash title=ENDPOINT -GET /testnet3/latest/hash +GET /testnet/latest/hash ``` Returns the latest block hash. diff --git a/documentation/testnet/public_endpoints/02_latest_block.md b/documentation/testnet/public_endpoints/02_latest_block.md index f654ff4bb5..33d2b7d63d 100644 --- a/documentation/testnet/public_endpoints/02_latest_block.md +++ b/documentation/testnet/public_endpoints/02_latest_block.md @@ -5,7 +5,7 @@ sidebar_label: Latest Block --- ```bash title=ENDPOINT -GET /testnet3/latest/block +GET /testnet/latest/block ``` Returns the latest block. diff --git a/documentation/testnet/public_endpoints/03_latest_state_root.md b/documentation/testnet/public_endpoints/03_latest_state_root.md index 7d8654377c..ca71354161 100644 --- a/documentation/testnet/public_endpoints/03_latest_state_root.md +++ b/documentation/testnet/public_endpoints/03_latest_state_root.md @@ -5,7 +5,7 @@ sidebar_label: Latest State Root --- ```bash title=ENDPOINT -GET /testnet3/latest/stateRoot +GET /testnet/latest/stateRoot ``` Returns the latest state root. diff --git a/documentation/testnet/public_endpoints/04_get_block.md b/documentation/testnet/public_endpoints/04_get_block.md index 8696cfe293..f85544951f 100644 --- a/documentation/testnet/public_endpoints/04_get_block.md +++ b/documentation/testnet/public_endpoints/04_get_block.md @@ -5,7 +5,7 @@ sidebar_label: Get Block --- ```bash title=ENDPOINT -GET /testnet3/block/{height_or_hash} +GET /testnet/block/{height_or_hash} ``` Returns the block for the given block height or block hash. diff --git a/documentation/testnet/public_endpoints/05_get_blocks.md b/documentation/testnet/public_endpoints/05_get_blocks.md index c42a8ee814..e3659af4d8 100644 --- a/documentation/testnet/public_endpoints/05_get_blocks.md +++ b/documentation/testnet/public_endpoints/05_get_blocks.md @@ -5,7 +5,7 @@ sidebar_label: Get Blocks --- ```javascript title=ENDPOINT -GET /testnet3/blocks?start={start_height}&end={end_height} +GET /testnet/blocks?start={start_height}&end={end_height} ``` Returns the blocks for the given block range. diff --git a/documentation/testnet/public_endpoints/06_get_height.md b/documentation/testnet/public_endpoints/06_get_height.md index c68d6fa636..546ba742c5 100644 --- a/documentation/testnet/public_endpoints/06_get_height.md +++ b/documentation/testnet/public_endpoints/06_get_height.md @@ -5,7 +5,7 @@ sidebar_label: Get Height --- ```bash title=ENDPOINT -GET /testnet3/height/{blockHash} +GET /testnet/height/{blockHash} ``` Returns the height for the given block hash. diff --git a/documentation/testnet/public_endpoints/07_get_block_transactions.md b/documentation/testnet/public_endpoints/07_get_block_transactions.md index 52cbe9923c..cc403f6076 100644 --- a/documentation/testnet/public_endpoints/07_get_block_transactions.md +++ b/documentation/testnet/public_endpoints/07_get_block_transactions.md @@ -5,7 +5,7 @@ sidebar_label: Get Block Transactions --- ```bash title=ENDPOINT -GET /testnet3/block/{height}/transactions +GET /testnet/block/{height}/transactions ``` Returns the transactions for the given block height. diff --git a/documentation/testnet/public_endpoints/08_get_transaction.md b/documentation/testnet/public_endpoints/08_get_transaction.md index e92c17ad4f..afcab721e1 100644 --- a/documentation/testnet/public_endpoints/08_get_transaction.md +++ b/documentation/testnet/public_endpoints/08_get_transaction.md @@ -5,7 +5,7 @@ sidebar_label: Get Transaction --- ```bash title=ENDPOINT -GET /testnet3/transaction/{transactionID} +GET /testnet/transaction/{transactionID} ``` Returns the transaction for the given transaction ID. diff --git a/documentation/testnet/public_endpoints/09_get_memory_pool_transactions.md b/documentation/testnet/public_endpoints/09_get_memory_pool_transactions.md index 6619d7703e..439c743677 100644 --- a/documentation/testnet/public_endpoints/09_get_memory_pool_transactions.md +++ b/documentation/testnet/public_endpoints/09_get_memory_pool_transactions.md @@ -5,7 +5,7 @@ sidebar_label: Get Memory Pool Transactions --- ```bash title=ENDPOINT -GET /testnet3/memoryPool/transactions +GET /testnet/memoryPool/transactions ``` Returns the transactions in the memory pool. diff --git a/documentation/testnet/public_endpoints/10_get_program.md b/documentation/testnet/public_endpoints/10_get_program.md index 2e7500f471..a455a2b3c0 100644 --- a/documentation/testnet/public_endpoints/10_get_program.md +++ b/documentation/testnet/public_endpoints/10_get_program.md @@ -5,7 +5,7 @@ sidebar_label: Get Program --- ```bash title=ENDPOINT -GET /testnet3/program/{programID} +GET /testnet/program/{programID} ``` Returns the program for the given program ID. diff --git a/documentation/testnet/public_endpoints/11_get_mapping_names.md b/documentation/testnet/public_endpoints/11_get_mapping_names.md index 4eb27cbdad..d4d44d7cd1 100644 --- a/documentation/testnet/public_endpoints/11_get_mapping_names.md +++ b/documentation/testnet/public_endpoints/11_get_mapping_names.md @@ -5,7 +5,7 @@ sidebar_label: Get Mapping Names --- ```bash title=ENDPOINT -GET /testnet3/program/{programID}/mappings +GET /testnet/program/{programID}/mappings ``` Returns the names of the mappings in a program for the given program ID. diff --git a/documentation/testnet/public_endpoints/12_get_mapping_value.md b/documentation/testnet/public_endpoints/12_get_mapping_value.md index 7501af72a5..7d0380443e 100644 --- a/documentation/testnet/public_endpoints/12_get_mapping_value.md +++ b/documentation/testnet/public_endpoints/12_get_mapping_value.md @@ -5,7 +5,7 @@ sidebar_label: Get Mapping Value --- ```bash title=ENDPOINT -GET /testnet3/program/{programID}/mapping/{mappingName}/{mappingKey} +GET /testnet/program/{programID}/mapping/{mappingName}/{mappingKey} ``` Returns the value in a key-value mapping corresponding to the supplied mappingKey. diff --git a/documentation/testnet/public_endpoints/13_get_state_path_for_commitment.md b/documentation/testnet/public_endpoints/13_get_state_path_for_commitment.md index 4c4ac9b879..a69f237e94 100644 --- a/documentation/testnet/public_endpoints/13_get_state_path_for_commitment.md +++ b/documentation/testnet/public_endpoints/13_get_state_path_for_commitment.md @@ -5,7 +5,7 @@ sidebar_label: Get State Path For Commitment --- ```bash title=ENDPOINT -GET /testnet3/statePath/{commitment} +GET /testnet/statePath/{commitment} ``` Returns the state path for the given commitment. diff --git a/documentation/testnet/public_endpoints/14_get_beacons.md b/documentation/testnet/public_endpoints/14_get_beacons.md deleted file mode 100644 index dc9cfdc67e..0000000000 --- a/documentation/testnet/public_endpoints/14_get_beacons.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: get_beacons -title: Get Beacons -sidebar_label: Get Beacons ---- - -```bash title=ENDPOINT -GET /testnet3/beacons -``` - -Returns the list of current beacon node addresses. - -### Arguments - -None - -### Response - -| Parameter | Type | Description | -|:---------:|:--------------------------------------:|:-------------------------:| -| `result` | [array](../../concepts/00_accounts.md) | The beacon Aleo addresses | \ No newline at end of file diff --git a/documentation/testnet/public_endpoints/14_get_committee.md b/documentation/testnet/public_endpoints/14_get_committee.md new file mode 100644 index 0000000000..62a658ec6f --- /dev/null +++ b/documentation/testnet/public_endpoints/14_get_committee.md @@ -0,0 +1,21 @@ +--- +id: get_committee +title: Get Committee +sidebar_label: Get Committee +--- + +```bash title=ENDPOINT +GET /testnet/latest/committee +``` + +Returns the list of current committee members and their stake. + +### Arguments + +None + +### Response + +| Parameter | Type | Description | +|:---------:|:--------------------------------------:|:----------------------------:| +| `result` | [array](../../concepts/00_accounts.md) | The latest committee members | \ No newline at end of file diff --git a/documentation/testnet/public_endpoints/15_get_peers_count.md b/documentation/testnet/public_endpoints/15_get_peers_count.md index ff4bdc91ad..83c31cdfd4 100644 --- a/documentation/testnet/public_endpoints/15_get_peers_count.md +++ b/documentation/testnet/public_endpoints/15_get_peers_count.md @@ -5,7 +5,7 @@ sidebar_label: Get Peers Count --- ```bash title=ENDPOINT -GET /testnet3/peers/count +GET /testnet/peers/count ``` Returns the number of peers connected to the node. diff --git a/documentation/testnet/public_endpoints/16_get_peers_all.md b/documentation/testnet/public_endpoints/16_get_peers_all.md index ad0a5ec1b0..8f70469674 100644 --- a/documentation/testnet/public_endpoints/16_get_peers_all.md +++ b/documentation/testnet/public_endpoints/16_get_peers_all.md @@ -5,7 +5,7 @@ sidebar_label: Get Peers All --- ```bash title=ENDPOINT -GET /testnet3/peers/all +GET /testnet/peers/all ``` Returns the peers connected to the node. diff --git a/documentation/testnet/public_endpoints/17_get_peers_all_metrics.md b/documentation/testnet/public_endpoints/17_get_peers_all_metrics.md index 79b47aa1e6..7afa913c7b 100644 --- a/documentation/testnet/public_endpoints/17_get_peers_all_metrics.md +++ b/documentation/testnet/public_endpoints/17_get_peers_all_metrics.md @@ -5,7 +5,7 @@ sidebar_label: Get Peers All Metrics --- ```bash title=ENDPOINT -GET /testnet3/peers/all/metrics +GET /testnet/peers/all/metrics ``` Returns the peers and their types connected to the node. diff --git a/documentation/testnet/public_endpoints/18_get_node_address.md b/documentation/testnet/public_endpoints/18_get_node_address.md index 9877a7d3b0..bfc743791d 100644 --- a/documentation/testnet/public_endpoints/18_get_node_address.md +++ b/documentation/testnet/public_endpoints/18_get_node_address.md @@ -5,7 +5,7 @@ sidebar_label: Get Node Address --- ```bash title=ENDPOINT -GET /testnet3/node/address +GET /testnet/node/address ``` Returns the address of the node. diff --git a/documentation/testnet/public_endpoints/19_find_block_hash.md b/documentation/testnet/public_endpoints/19_find_block_hash.md index 02a8a150a2..147c8c51f3 100644 --- a/documentation/testnet/public_endpoints/19_find_block_hash.md +++ b/documentation/testnet/public_endpoints/19_find_block_hash.md @@ -5,7 +5,7 @@ sidebar_label: Find Block Hash --- ```bash title=ENDPOINT -GET /testnet3/find/blockHash/{transactionID} +GET /testnet/find/blockHash/{transactionID} ``` Returns the block hash of the block containing the given transaction ID. diff --git a/documentation/testnet/public_endpoints/20_find_transaction_id_from_program_id.md b/documentation/testnet/public_endpoints/20_find_transaction_id_from_program_id.md index 821aa24cfc..0dbed16ba7 100644 --- a/documentation/testnet/public_endpoints/20_find_transaction_id_from_program_id.md +++ b/documentation/testnet/public_endpoints/20_find_transaction_id_from_program_id.md @@ -5,7 +5,7 @@ sidebar_label: Find Transaction ID from Program ID --- ```bash title=ENDPOINT -GET /testnet3/find/transactionID/deployment/{programID} +GET /testnet/find/transactionID/deployment/{programID} ``` Returns the transaction ID of the transaction containing the given program ID. diff --git a/documentation/testnet/public_endpoints/21_find_transaction_id_from_transition_id.md b/documentation/testnet/public_endpoints/21_find_transaction_id_from_transition_id.md index 8699cb8c02..530516ba84 100644 --- a/documentation/testnet/public_endpoints/21_find_transaction_id_from_transition_id.md +++ b/documentation/testnet/public_endpoints/21_find_transaction_id_from_transition_id.md @@ -5,7 +5,7 @@ sidebar_label: Find Transaction ID from Transition ID --- ```bash title=ENDPOINT -GET /testnet3/find/transactionID/{transitionID} +GET /testnet/find/transactionID/{transitionID} ``` Returns the transaction ID of the transaction containing the given transition ID. diff --git a/documentation/testnet/public_endpoints/22_find_transition_id.md b/documentation/testnet/public_endpoints/22_find_transition_id.md index ed72c225f9..b49870b8d5 100644 --- a/documentation/testnet/public_endpoints/22_find_transition_id.md +++ b/documentation/testnet/public_endpoints/22_find_transition_id.md @@ -5,7 +5,7 @@ sidebar_label: Find Transition ID --- ```bash title=ENDPOINT -GET /testnet3/find/transitionID/{inputOrOutputID} +GET /testnet/find/transitionID/{inputOrOutputID} ``` Returns the transition ID of the transition corresponding to the ID of the input or output. diff --git a/documentation/testnet/public_endpoints/23_get_env_info.md b/documentation/testnet/public_endpoints/23_get_env_info.md index b75c4e37c3..12483b02f0 100644 --- a/documentation/testnet/public_endpoints/23_get_env_info.md +++ b/documentation/testnet/public_endpoints/23_get_env_info.md @@ -5,7 +5,7 @@ sidebar_label: Get Environment Info --- ```bash title=ENDPOINT -GET /testnet3/node/env +GET /testnet/node/env ``` Returns the environment info of the node. diff --git a/documentation/testnet/public_endpoints/24_transaction_broadcast.md b/documentation/testnet/public_endpoints/24_transaction_broadcast.md index c6c42acc8e..9432285dd5 100644 --- a/documentation/testnet/public_endpoints/24_transaction_broadcast.md +++ b/documentation/testnet/public_endpoints/24_transaction_broadcast.md @@ -5,7 +5,7 @@ sidebar_label: Transaction Broadcast --- ```bash title=ENDPOINT -POST /testnet3/transaction/broadcast +POST /testnet/transaction/broadcast ``` Broadcasts the transaction to the ledger. From 665cbbb1f0f90492ec7d36e0c91f957a45b3d3c7 Mon Sep 17 00:00:00 2001 From: Jake Tarnow Date: Mon, 29 Jul 2024 11:22:26 -0700 Subject: [PATCH 2/4] minor nits --- documentation/00_overview.md | 4 +--- documentation/00_sdk_overview.md | 1 - 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/documentation/00_overview.md b/documentation/00_overview.md index 12ebdf31b3..bf8924b860 100644 --- a/documentation/00_overview.md +++ b/documentation/00_overview.md @@ -55,11 +55,9 @@ An index of all pages available in this documentation. - [Aleo Instructions Grammar](./aleo/06_grammar.md) - [Aleo Instructions Code Editor Plugins](./aleo/07_tooling.md) -## Testnet - ### Chapter 5: Getting Started -- [Testnet III.](./testnet/getting_started/00_overview.md) +- [Testnet](./testnet/getting_started/00_overview.md) ### Chapter 6: API Reference diff --git a/documentation/00_sdk_overview.md b/documentation/00_sdk_overview.md index f50de30eba..eb31db0c97 100644 --- a/documentation/00_sdk_overview.md +++ b/documentation/00_sdk_overview.md @@ -15,7 +15,6 @@ several TypeScript & JavaScript libraries which provide the following functional 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 From da00e745a789831c3d4351194b8199ddcc0336a0 Mon Sep 17 00:00:00 2001 From: Jake Tarnow Date: Mon, 29 Jul 2024 12:03:15 -0700 Subject: [PATCH 3/4] address comments --- documentation/00_overview.md | 2 +- documentation/00_sdk_overview.md | 2 +- documentation/testnet/getting_started/00_overview.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/00_overview.md b/documentation/00_overview.md index 1c0b868e9b..f54cdc032c 100644 --- a/documentation/00_overview.md +++ b/documentation/00_overview.md @@ -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 Committee](./testnet/public_endpoints/14_get_committee) +- [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) diff --git a/documentation/00_sdk_overview.md b/documentation/00_sdk_overview.md index 8888435423..e84ab0ecaa 100644 --- a/documentation/00_sdk_overview.md +++ b/documentation/00_sdk_overview.md @@ -32,7 +32,7 @@ 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-aleo-app/00_app_installation.md) - Zero-Knowledge Web App Examples Create Aleo App diff --git a/documentation/testnet/getting_started/00_overview.md b/documentation/testnet/getting_started/00_overview.md index 6aad2d1b07..9e566285ea 100644 --- a/documentation/testnet/getting_started/00_overview.md +++ b/documentation/testnet/getting_started/00_overview.md @@ -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_committee) +- [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) From c076cfd638aaaac1bb28fda2534ce0b3b3b91281 Mon Sep 17 00:00:00 2001 From: Jake Tarnow Date: Mon, 29 Jul 2024 15:02:41 -0700 Subject: [PATCH 4/4] nit: update create-leo-app --- documentation/00_sdk_overview.md | 6 +++--- .../testnet/getting_started/03_deploy_and_execute_demo.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/00_sdk_overview.md b/documentation/00_sdk_overview.md index e84ab0ecaa..85d0104e5e 100644 --- a/documentation/00_sdk_overview.md +++ b/documentation/00_sdk_overview.md @@ -34,9 +34,9 @@ first zero knowledge web app. ## 2. [Create-leo-App](./sdk/create-aleo-app/00_app_installation.md) - Zero-Knowledge Web App Examples - Create Aleo App + Create Leo App -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 @@ -44,7 +44,7 @@ start with working examples should start here. You can start with a template by running ```bash -npm create aleo-app@latest +npm create leo-app@latest ``` #### Source: [`sdk/create-leo-app`](https://github.com/ProvableHQ/sdk/tree/testnet3/create-leo-app) diff --git a/documentation/testnet/getting_started/03_deploy_and_execute_demo.md b/documentation/testnet/getting_started/03_deploy_and_execute_demo.md index 5a57e18b03..cfe986a91b 100644 --- a/documentation/testnet/getting_started/03_deploy_and_execute_demo.md +++ b/documentation/testnet/getting_started/03_deploy_and_execute_demo.md @@ -169,4 +169,4 @@ Then just paste the following command in your terminal snarkos developer execute "${APPNAME}.aleo" "main" "1u32" "2u32" --private-key "${PRIVATEKEY}" --query "https://api.explorer.aleo.org/v1" --broadcast "https://api.explorer.aleo.org/v1/testnet/transaction/broadcast" --fee 1000000 --record "${RECORD}" ``` -Awesome! You have successfully deployed and executed a Leo application to Testnet III, how exciting 🎉 +Awesome! You have successfully deployed and executed a Leo application to Testnet, how exciting 🎉