Skip to content

Commit ea2a805

Browse files
Merge branch 'mainnet' into feat/hash-functions
2 parents f7d37be + 0282c70 commit ea2a805

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+348
-334
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ labels: bug
88
## 🐛 Bug Report
99

1010
<!--
11-
What's the bug in the Aleo SDK that you found?
11+
What's the bug in the Provable SDK that you found?
1212
How serious is this bug and what is affected?
1313
14-
To report a security issue in the Aleo SDK, please email [email protected].
14+
To report a security issue in the Provable SDK, please email [email protected].
1515
-->
1616

1717
(Write your description here)
1818

1919
## Steps to Reproduce
2020

21-
<!-- How do I reproduce this issue in the Aleo SDK? -->
21+
<!-- How do I reproduce this issue in the Provable SDK? -->
2222

2323
#### Code snippet to reproduce
2424

@@ -35,14 +35,14 @@ labels: bug
3535
## Expected Behavior
3636

3737
<!--
38-
What was supposed to happen in the Aleo SDK?
38+
What was supposed to happen in the Provable SDK?
3939
What happened instead?
4040
-->
4141

4242
(Write what you expected to happen here)
4343

4444
## Your Environment
4545

46-
- <!-- Aleo SDK Version -->
46+
- <!-- Provable SDK Version -->
4747
- <!-- Rust Version -->
4848
- <!-- Computer OS -->

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ labels: 'documentation'
88
## 📚 Documentation
99

1010
<!--
11-
Did you find a mistake in the Aleo SDK documentation?
12-
Is there documentation about the Aleo SDK that's missing?
11+
Did you find a mistake in the Provable SDK documentation?
12+
Is there documentation about the Provable SDK that's missing?
1313
-->
1414

1515
(Write your answer here.)

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ labels: feature
88
## 🚀 Feature
99

1010
<!--
11-
What is the feature you would like to see in the Aleo SDK?
11+
What is the feature you would like to see in the Provable SDK?
1212
-->
1313

1414
(Write your description here)
1515

1616
## Motivation
1717

1818
<!--
19-
Why should this feature be implemented in the Aleo SDK?
20-
How would this feature be used in the Aleo SDK?
19+
Why should this feature be implemented in the Provable SDK?
20+
How would this feature be used in the Provable SDK?
2121
2222
Is this feature request related to a problem? If so, please describe.
2323
Please link to any relevant issues or other PRs!
@@ -28,8 +28,8 @@ labels: feature
2828
## Implementation
2929

3030
<!--
31-
What needs to be built for the feature to be supported in the Aleo SDK?
32-
What components of the Aleo SDK will be affected by this design (if any)?
31+
What needs to be built for the feature to be supported in the Provable SDK?
32+
What components of the Provable SDK will be affected by this design (if any)?
3333
How should this feature be implemented?
3434
-->
3535

.github/ISSUE_TEMPLATE/proposal.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
name: 💥 Proposal
3-
about: Propose a non-trivial change to the Aleo SDK
3+
about: Propose a non-trivial change to the Provable SDK
44
title: "[Proposal]"
55
labels: 'proposal'
66
---
77

88
## 💥 Proposal
99

1010
<!--
11-
What is your proposal for the Aleo SDK?
12-
What are the implications of this proposal to the Aleo SDK?
13-
Does your proposal affect other aspects of the Aleo SDK as well?
11+
What is your proposal for the Provable SDK?
12+
What are the implications of this proposal to the Provable SDK?
13+
Does your proposal affect other aspects of the Provable SDK as well?
1414
-->
1515

1616
(Write your proposal here)

.resources/license_header

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
// Copyright (C) 2019-2025 Provable Inc.
2-
// This file is part of the Aleo SDK library.
2+
// This file is part of the Provable SDK library.
33

4-
// The Aleo SDK library is free software: you can redistribute it and/or modify
4+
// The Provable SDK library is free software: you can redistribute it and/or modify
55
// it under the terms of the GNU General Public License as published by
66
// the Free Software Foundation, either version 3 of the License, or
77
// (at your option) any later version.
88

9-
// The Aleo SDK library is distributed in the hope that it will be useful,
9+
// The Provable SDK library is distributed in the hope that it will be useful,
1010
// but WITHOUT ANY WARRANTY; without even the implied warranty of
1111
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1212
// GNU General Public License for more details.
1313

1414
// You should have received a copy of the GNU General Public License
15-
// along with the Aleo SDK library. If not, see <https://www.gnu.org/licenses/>.
15+
// along with the Provable SDK library. If not, see <https://www.gnu.org/licenses/>.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
# Zero-Knowledge Web App SDK
1010

11-
The [Aleo SDK](https://github.com/ProvableHQ/sdk) provides tools for building zero-knowledge applications. It consists of
11+
The [Provable SDK](https://github.com/ProvableHQ/sdk) provides tools for building zero-knowledge applications. It consists of
1212
several TypeScript & JavaScript libraries which provide the following functionality:
1313
1. [Aleo account management](https://provable.tools/account)
1414
2. [Web-based program execution and deployment](https://provable.tools/develop)
@@ -20,20 +20,20 @@ several TypeScript & JavaScript libraries which provide the following functional
2020
All of this functionality is demonstrated on [Provable.tools](https://provable.tools).
2121

2222

23-
The Aleo SDK is divided into three TypeScript/JavaScript packages:
23+
The Provable SDK is divided into three TypeScript/JavaScript packages:
2424

25-
## 1. Aleo SDK - Build Zero-Knowledge Web Apps
25+
## 1. Provable SDK - Build Zero-Knowledge Web Apps
2626

27-
<a href="https://www.npmjs.com/package/@provablehq/sdk"> <img alt="Aleo SDK" src="https://img.shields.io/npm/l/%40provablehq%2Fsdk?label=NPM%20-%20Aleo%20SDK&labelColor=green&color=blue"></a>
27+
<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>
2828

29-
The official Aleo SDK providing JavaScript/TypeScript tools for creating zero-knowledge applications.
29+
The official Provable SDK providing JavaScript/TypeScript tools for creating zero-knowledge applications.
3030

3131
### ⚡ Build your own app
3232

33-
Start here with the [Aleo SDK Readme](https://github.com/ProvableHQ/sdk#readme) to get started building your
33+
Start here with the [Provable SDK Readme](https://github.com/ProvableHQ/sdk#readme) to get started building your
3434
first zero-knowledge web app.
3535

36-
#### Source: [`Aleo SDK`](https://www.npmjs.com/package/@provablehq/sdk)
36+
#### Source: [`Provable SDK`](https://www.npmjs.com/package/@provablehq/sdk)
3737

3838
## 2. Create-Leo-App - Zero-Knowledge Web App Examples
3939
<a href="https://www.npmjs.com/package/create-leo-app"> <img alt="Create Leo App" src="https://img.shields.io/npm/l/create-leo-app?label=NPM%20-%20Create-Leo-App&labelColor=green&color=blue"></a>
@@ -61,7 +61,7 @@ Source: [Aleo Wasm](https://www.npmjs.com/package/@provablehq/wasm)
6161
## 📚 Documentation
6262

6363
#### [API Documentation](https://docs.leo-lang.org/sdk/typescript/overview)
64-
API Documentation, tutorials for the Aleo SDK, and documentation on how to build Leo and Aleo Instructions programs can
64+
API Documentation, tutorials for the Provable SDK, and documentation on how to build Leo and Aleo Instructions programs can
6565
be found on the [Leo Developer Docs](https://docs.leo-lang.org/sdk/typescript/overview) page.
6666

6767
#### [SDK Readme](https://github.com/ProvableHQ/sdk/tree/mainnet/sdk#readme)

create-leo-app/template-extension/src/service_worker.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ async function createOffscreen(path) {
1313
await chrome.offscreen.createDocument({
1414
url: offscreenUrl,
1515
reasons: ["WORKERS"],
16-
justification: "Top-level await and Workers cannot be used in service workers, but they are necessary to use the Aleo SDK.",
16+
justification: "Top-level await and Workers cannot be used in service workers, but they are necessary to use the Provable SDK.",
1717
});
1818
}
1919

create-leo-app/template-offline-public-transaction-ts/README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Offline Transaction Builder
22

33
## 1. Overview
4-
### 1.1 Proving Keys for Zero Knowledge Function Execution
5-
To achieve zero knowledge execution, all Aleo functions require a `ProvingKey` and `VerifyingKey` in order to build a
6-
zero knowledge ZkSnark proof of execution. If a user does not possess these keys for a function, they are normally
4+
### 1.1 Proving Keys for Zero-Knowledge Function Execution
5+
To achieve zero-knowledge execution, all Aleo functions require a `ProvingKey` and `VerifyingKey` in order to build a
6+
zero-knowledge zk-SNARK proof of execution. If a user does not possess these keys for a function, they are normally
77
downloaded from the internet when the function is called.
88

99
### 1.2 Key Providers
@@ -21,31 +21,27 @@ the internet for it. This provides a way to build Aleo execution transactions wi
2121
This pathway is suitable for use-cases such as hardware wallets or air-gapped machines used
2222
for building secure transactions.
2323

24-
### 1.4 Assumptions
24+
### 1.4 Transaction Types
2525

26-
The key material in this example is assumed to be pre-downloaded onto the machine performing the
27-
construction of the offline transaction.
26+
Several types of transactions can be built and executed using this template:
27+
28+
`bond_public`
29+
`unbond_public`
30+
`claim_unbond_public`
2831

2932
## 2. Usage
3033

31-
### 2.1 Pre-Download the Keys
32-
First run this command online to download the key material to disk:
34+
`npm run build`
3335

34-
`npm start`
36+
`npm run dev`
3537

3638
Once this command is run, all proving keys for the `transfer_public`, `bond_public`, `unbond_public`, and
37-
`claim_unbond_public` functions will be downloaded to the `./keys` folder. The machine can then be disconnected from
39+
`claim_unbond_public` functions will be downloaded to the `dist/keys` folder. The machine can then be disconnected from
3840
the internet and the `OfflineKeyProvider` will search this directory for the function proving keys when building the
3941
transaction instead of connecting to the internet. Alternatively you can skip the online step entirely by adding the proving key creating this directory manually and
4042
adding the key material yourself.
4143

42-
### 2.2 Build the Transaction Offline
43-
44-
Once the key material is downloaded, turn off your internet connection and run the following command:
45-
46-
`npm start`
47-
48-
You should see the transactions being built and the resulting transaction IDs printed to the console.
44+
Once the keys are downloaded to your local machine, the offline transactions will be built without requiring an internet connection.
4945

5046
## 3. Notes
5147

create-leo-app/template-offline-public-transaction-ts/src/helpers.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ async function preDownloadTransferKeys() {
2828
const keysDirPath = path.join(__dirname, "keys");
2929
await fsPromises.mkdir(keysDirPath, { recursive: true });
3030

31-
for (const keyData of [CREDITS_PROGRAM_KEYS.transfer_public, CREDITS_PROGRAM_KEYS.fee_public]) {
31+
for (const keyData of [CREDITS_PROGRAM_KEYS.transfer_public, CREDITS_PROGRAM_KEYS.fee_public, CREDITS_PROGRAM_KEYS.transfer_public_as_signer]) {
3232
try {
3333
keyPaths[keyData.locator] = await downloadAndSaveKey(keyData, keysDirPath);
3434
} catch (error) {

0 commit comments

Comments
 (0)