Skip to content

Commit e1d3dd5

Browse files
Merge pull request #967 from ProvableHQ/fix/documentation-cleanup
[Documentation] SDK readme anchor link cleanup
2 parents 1d3a5cb + 4a290f7 commit e1d3dd5

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

create-leo-app/template-react-leo/src/App.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ function App() {
3434
try {
3535
const result = await aleoWorker.deployProgram(helloworld_program);
3636
console.log("Transaction:")
37-
console.log("https://explorer.hamp.app/transaction?id=" + result)
37+
console.log("https://explorer.provable.com/transaction/" + result)
3838
alert("Transaction ID: " + result);
3939
} catch (e) {
4040
console.log(e)

create-leo-app/template-react-ts/src/App.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ function App() {
3434
try {
3535
const result = await aleoWorker.deployProgram(helloworld_program);
3636
console.log("Transaction:")
37-
console.log("https://explorer.hamp.app/transaction?id=" + result)
37+
console.log("https://explorer.provable.com/transaction/" + result)
3838
alert("Transaction ID: " + result);
3939
} catch (e) {
4040
console.log(e)

sdk/README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,29 +34,29 @@ The Aleo SDK provides the following functionality (Click to see examples):
3434

3535
* [Installation](#Installation)
3636
* [Usage](#Usage)
37-
* [Zero-Knowledge Web App Examples](#Zero-Knowledge-Web-App-Examples)
37+
* [Zero-Knowledge Web App Examples](#Getting-Started-Zero-Knowledge-Web-App-Examples)
3838
* [Create Leo App](#create-leo-app)
3939
* [Provable.tools](#provabletools)
4040
* [Create An Aleo Account](#1-create-an-aleo-account)
4141
* [Execute Aleo Programs](#2-execute-aleo-programs)
4242
* [Aleo Programs](#21-aleo-programs)
4343
* [Program Execution Model](#22-program-execution-model)
44-
* [WebAssembly Initialization](#23-wasm-initialization)
44+
* [Multithreading](#23-multithreading)
4545
* [Local Program Execution](#24-local-program-execution)
4646
* [Online Program Execution](#25-program-execution-on-the-aleo-network)
4747
* [Program Proving Keys and Records](#26-program-proving-keys--program-records)
4848
* [Deploy Programs](#27-deploy-a-new-program-to-the-aleo-network)
4949
* [React Example](#28-react-example)
50-
* [Aleo Credit Transfers](#3-value-transfers)
50+
* [Aleo Credit Transfers](#3-aleo-credit-transfers)
5151
* [Aleo Credits](#31-aleo-credits)
52-
* [Transfer Aleo Credits](#32-transfer-aleo-credits)
52+
* [Transfer Aleo Credits](#32-transferring-aleo-credits)
5353
* [Check Public Balances](#32-checking-public-balances)
5454
* [Program Data and Private State](#4-managing-program-data-and-private-state)
55-
* [Private State Data: Records](#41-private-state-data--records)
56-
* [Record Usage Example](#42-record-usage-example--private-value-transfers)
57-
* [Public State Data: Mappings](#43-public-state-data--mappings)
55+
* [Private State Data: Records](#41-private-state-data-records)
56+
* [Record Usage Example](#42-record-usage-example-private-value-transfers)
57+
* [Public State Data: Mappings](#43-public-state-data-mappings)
5858
* [Reading Mappings](#44-reading-mappings)
59-
* [Initializing and Updating Mappings](#45-initializing--updating-mappings)
59+
* [Updating Mappings](#45-updating-mappings)
6060
* [Communicating with the Aleo Network](#5-communicating-with-the-aleo-network)
6161
* [Further Documentation](#further-documentation)
6262
## Installation
@@ -215,7 +215,8 @@ The SDK provides the ability to execute Aleo programs 100% client-side within th
215215

216216
The `ProgramManager` object encapsulates the functionality for executing programs and making zero-knowledge proofs about
217217
them. Under the hood it uses cryptographic code compiled from [SnarkVM](https://docs.leo-lang.org/aleo) into WebAssembly
218-
with JavaScript bindings that allow for the execution of Aleo programs fully within the browser.
218+
with JavaScript bindings that allow for the execution of Aleo programs fully within the browser. Users interested in lower-level
219+
details on how this is achieved can visit the [aleo-wasm](https://crates.io/crates/aleo-wasm) crate.
219220

220221
The basic execution flow of a program within the SDK is as follows:
221222
1. A web app creates an instance of the `ProgramManager` object.
@@ -226,7 +227,7 @@ The basic execution flow of a program within the SDK is as follows:
226227
6. The result is returned to the javascript environment in the form of an `Execution Transaction`.
227228
7. The execution is sent to the Aleo network.
228229

229-
### 2.3 WebAssembly Initialization
230+
### 2.3 Multithreading
230231

231232
You can enable multithreading by calling the `initThreadPool` function. This will run the SDK on multiple workers,
232233
which significantly speeds up performance:
@@ -426,7 +427,7 @@ step by running:
426427

427428
`npm create leo-app@latest`
428429

429-
You will then be prompted to select either Vanilla, React, or Node.js as the template for the project. For this example, select Vanilla.
430+
You will then be prompted to select either Vanilla, React, or Node.js as the template for the project. For this example, select React.
430431

431432
#### Program execution
432433

@@ -884,7 +885,7 @@ const publicCredits = networkClient.getMapping("credits.aleo", "[a valid aleo ac
884885
assert(publicCredits === "0u64");
885886
```
886887

887-
### 4.5 Initializing & updating mappings
888+
### 4.5 Updating mappings
888889
Updating mappings is done by executing a program function on the Aleo network which has a finalize block that updates the
889890
program's mapping. For instance, the `transfer_public` function in the `credits.aleo` program updates the `account`
890891
mapping (and thus a user's balance) when called.

0 commit comments

Comments
 (0)