|
1 |
| -# Aleo SDK |
| 1 | +# Provable SDK |
2 | 2 | <p align="center">
|
3 |
| - <img alt="Aleo SDK" width="1412" src="../.resources/banner.png"> |
| 3 | + <img alt="Provable SDK" width="1412" src="../.resources/banner.png"> |
4 | 4 | </p>
|
5 | 5 |
|
6 | 6 | <p align="center">
|
|
12 | 12 |
|
13 | 13 | ## Tools for Building Zero-Knowledge Web Apps
|
14 | 14 |
|
15 |
| -The Aleo SDK is a JavaScript library for building zero-knowledge web applications in both web browsers and Node.js. |
| 15 | +The Provable SDK is a JavaScript library for building zero-knowledge web applications in both web browsers and Node.js. |
16 | 16 |
|
17 | 17 | ## Overview
|
18 | 18 |
|
19 | 19 | Aleo provides the ability for users to create programs and execute them in zero knowledge through the usage of the
|
20 | 20 | [Varuna ZKSnark](https://alphaswapdex.medium.com/part-ii-the-technical-architecture-of-the-aleo-blockchain-marlin-and-varuna-71c6d48eb355).
|
21 | 21 |
|
22 |
| -The Aleo SDK provides the tools to use these programs both within Nodejs and web browsers allowing users to build |
| 22 | +The Provable SDK provides the tools to use these programs both within Nodejs and web browsers allowing users to build |
23 | 23 | privacy-preserving applications throughout the web stack.
|
24 | 24 |
|
25 |
| -The Aleo SDK provides the following functionality (Click to see examples): |
| 25 | +The Provable SDK provides the following functionality (Click to see examples): |
26 | 26 | 1. [Aleo account management](https://provable.tools/account)
|
27 | 27 | 2. [Web-based program execution and deployment](https://provable.tools/develop)
|
28 | 28 | 3. [Aleo credit transfers](https://provable.tools/transfer)
|
@@ -69,11 +69,11 @@ To clone the repository, run:
|
69 | 69 |
|
70 | 70 | ### NPM & YARN
|
71 | 71 |
|
72 |
| -To install the Aleo SDK from NPM run: |
| 72 | +To install the Provable SDK from NPM run: |
73 | 73 |
|
74 | 74 | `npm install @provablehq/sdk` in your own project's root,
|
75 | 75 |
|
76 |
| -To install the Aleo SDK from Yarn run: |
| 76 | +To install the Provable SDK from Yarn run: |
77 | 77 |
|
78 | 78 | `yarn add @provablehq/sdk`.
|
79 | 79 |
|
@@ -209,7 +209,7 @@ stores called `mappings` which store a program's public on-chain state.
|
209 | 209 | specific block and all changes the execution made to the program's state are recorded within the Aleo blockchain.
|
210 | 210 |
|
211 | 211 |
|
212 |
| -#### Program Execution with the Aleo SDK |
| 212 | +#### Program Execution with the Provable SDK |
213 | 213 |
|
214 | 214 | The SDK provides the ability to execute Aleo programs 100% client-side within the browser or Node.js.
|
215 | 215 |
|
@@ -351,7 +351,7 @@ Executing Aleo programs using zero-knowledge requires two additional pieces of i
|
351 | 351 | on records can be found in the [Records](#41-private-state-data--records) section below.
|
352 | 352 |
|
353 | 353 | For this reason, all programs will need proving and verifying keys to operate and many functions in Aleo programs will
|
354 |
| -require records as inputs. To simplify the process of managing keys and records, the Aleo SDK provides two abstractions |
| 354 | +require records as inputs. To simplify the process of managing keys and records, the Provable SDK provides two abstractions |
355 | 355 | for managing these concepts:
|
356 | 356 |
|
357 | 357 | 1. **KeyProvider:** When program functions execute, they will by default synthesize the proving and verifying keys needed to
|
|
0 commit comments