@provablehq/sdk 0.8.4 → 0.8.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
id: overview
|
|
3
|
-
title: SDK for Building Zero Knowledge Web Apps
|
|
4
|
-
sidebar_label: Overview
|
|
5
|
-
---
|
|
1
|
+
# Provable SDK for Building Zero-Knowledge Web Apps
|
|
6
2
|
|
|
7
3
|
<p align="center">
|
|
8
|
-
<img alt="
|
|
4
|
+
<img alt="Provable SDK" width="1412" src="../.resources/banner.png">
|
|
9
5
|
</p>
|
|
10
6
|
|
|
11
7
|
<p align="center">
|
|
@@ -13,7 +9,7 @@ sidebar_label: Overview
|
|
|
13
9
|
<a href="https://circleci.com/gh/ProvableHQ/sdk"><img src="https://circleci.com/gh/ProvableHQ/sdk.svg?style=svg"></a>
|
|
14
10
|
<a href="https://discord.com/invite/aleo"><img src="https://img.shields.io/discord/700454073459015690?logo=discord"/></a>
|
|
15
11
|
<a href="https://github.com/ProvableHQ/sdk#%EF%B8%8F-contributors"><img src="https://img.shields.io/badge/contributors-23-ee8449"/></a>
|
|
16
|
-
<a href="https://www.npmjs.com/package/@provablehq/sdk"> <img alt="
|
|
12
|
+
<a href="https://www.npmjs.com/package/@provablehq/sdk"> <img alt="Provable SDK" src="https://img.shields.io/npm/l/%40provablehq%2Fsdk?label=NPM%20-%20Aleo%20SDK&labelColor=green&color=blue"></a>
|
|
17
13
|
</p>
|
|
18
14
|
|
|
19
15
|
|
|
@@ -21,20 +17,20 @@ The [Provable SDK](https://github.com/ProvableHQ/sdk) is an open source TypeScri
|
|
|
21
17
|
SDK provides an easy API for using Aleo's core suite of cryptographic primitives, zk-SNARKs and private program execution
|
|
22
18
|
protocol directly within Javascript. It also provides APIs for interacting with nodes and applications on the Aleo Network.
|
|
23
19
|
|
|
24
|
-
Applications built with the
|
|
20
|
+
Applications built with the Provable SDK include:
|
|
25
21
|
* **Private DeFi**
|
|
26
22
|
* **Private Data Custody Systems**
|
|
27
23
|
* **Zk Games & Gaming Toolkits**
|
|
28
24
|
* **ZkML**
|
|
29
|
-
* **Zero
|
|
25
|
+
* **Zero-Knowledge Identity Management**
|
|
30
26
|
* **Aleo Wallets**
|
|
31
27
|
|
|
32
28
|
## Features
|
|
33
|
-
The
|
|
29
|
+
The Provable SDK provides the following features. Follow the links below for live demonstrations of these features on
|
|
34
30
|
[provable.tools](https://provable.tools)
|
|
35
31
|
1. [Aleo account management](https://provable.tools/account)
|
|
36
32
|
2. [Aleo cryptographic primitives](https://provable.tools/algebra)
|
|
37
|
-
3. [Web based zero
|
|
33
|
+
3. [Web based zero-knowledge program execution and deployment](https://provable.tools/develop)
|
|
38
34
|
4. [Aleo credit transfers and staking](https://provable.tools/transfer)
|
|
39
35
|
5. [Management of program state](https://provable.tools/protocol)
|
|
40
36
|
6. [Communication with the Aleo network](https://provable.tools/rest)
|
|
@@ -45,9 +41,9 @@ The Aleo SDK provides the following features. Follow the links below for live de
|
|
|
45
41
|
Developers interested in using the SDK to build private web applications can get started with the following resources.
|
|
46
42
|
|
|
47
43
|
### [The SDK Guide](https://docs.explorer.provable.com/docs/sdk/6p7047svvq2ox-intro-to-aleo)
|
|
48
|
-
<a href="https://www.npmjs.com/package/@provablehq/sdk"> <img alt="
|
|
44
|
+
<a href="https://www.npmjs.com/package/@provablehq/sdk"> <img alt="Provable SDK" src="https://img.shields.io/npm/l/%40provablehq%2Fsdk?label=NPM%20-%20Aleo%20SDK&labelColor=green&color=blue"></a>
|
|
49
45
|
|
|
50
|
-
A step-by-step guide to building private web applications with the
|
|
46
|
+
A step-by-step guide to building private web applications with the Provable SDK. The guide covers creating Aleo accounts,
|
|
51
47
|
transferring and receiving aleo credits, executing/deploying/interacting with Aleo programs, managing private and public
|
|
52
48
|
state, and best practices for building private web applications.
|
|
53
49
|
|
|
@@ -64,6 +60,6 @@ For developers who prefer to dive straight into the code, the SDK API documentat
|
|
|
64
60
|
for all the SDK's classes, methods, and interfaces. The documentation is generated from the SDK's TypeScript source code.
|
|
65
61
|
|
|
66
62
|
### [Leo Language Documentation](https://docs.leo-lang.org)
|
|
67
|
-
For developers who want to build their own zero
|
|
68
|
-
programming language for writing zero
|
|
63
|
+
For developers who want to build their own zero-knowledge programs, the Leo Language provides an easy-to-use imperative
|
|
64
|
+
programming language for writing zero-knowledge programs on Aleo. In conjuction with the SDK, private programs built
|
|
69
65
|
using Leo can be turned into fully functional private web applications.
|