Skip to content

Commit 10f743d

Browse files
Merge pull request #987 from ProvableHQ/chore/update-license-headers
[Chore] Change Aleo SDK to Provable SDK in License Headers
2 parents 02f1356 + 56899ff commit 10f743d

Some content is hidden

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

70 files changed

+266
-266
lines changed

.github/ISSUE_TEMPLATE/bug.md

+5-5
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

+2-2
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

+5-5
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

+4-4
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

+4-4
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

+8-8
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

+1-1
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

sdk/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Aleo SDK
1+
# Provable SDK
22
<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">
44
</p>
55

66
<p align="center">
@@ -12,17 +12,17 @@
1212

1313
## Tools for Building Zero-Knowledge Web Apps
1414

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.
1616

1717
## Overview
1818

1919
Aleo provides the ability for users to create programs and execute them in zero knowledge through the usage of the
2020
[Varuna ZKSnark](https://alphaswapdex.medium.com/part-ii-the-technical-architecture-of-the-aleo-blockchain-marlin-and-varuna-71c6d48eb355).
2121

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
2323
privacy-preserving applications throughout the web stack.
2424

25-
The Aleo SDK provides the following functionality (Click to see examples):
25+
The Provable SDK provides the following functionality (Click to see examples):
2626
1. [Aleo account management](https://provable.tools/account)
2727
2. [Web-based program execution and deployment](https://provable.tools/develop)
2828
3. [Aleo credit transfers](https://provable.tools/transfer)
@@ -69,11 +69,11 @@ To clone the repository, run:
6969

7070
### NPM & YARN
7171

72-
To install the Aleo SDK from NPM run:
72+
To install the Provable SDK from NPM run:
7373

7474
`npm install @provablehq/sdk` in your own project's root,
7575

76-
To install the Aleo SDK from Yarn run:
76+
To install the Provable SDK from Yarn run:
7777

7878
`yarn add @provablehq/sdk`.
7979

@@ -209,7 +209,7 @@ stores called `mappings` which store a program's public on-chain state.
209209
specific block and all changes the execution made to the program's state are recorded within the Aleo blockchain.
210210

211211

212-
#### Program Execution with the Aleo SDK
212+
#### Program Execution with the Provable SDK
213213

214214
The SDK provides the ability to execute Aleo programs 100% client-side within the browser or Node.js.
215215

@@ -351,7 +351,7 @@ Executing Aleo programs using zero-knowledge requires two additional pieces of i
351351
on records can be found in the [Records](#41-private-state-data--records) section below.
352352

353353
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
355355
for managing these concepts:
356356

357357
1. **KeyProvider:** When program functions execute, they will by default synthesize the proving and verifying keys needed to

sdk/docs/index.html

+1-1
Large diffs are not rendered by default.

wasm/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ wasm-pack test --[firefox/chrome/safari]
5858
Further documentation and tutorials as to how to use the modules built from this crate to build web apps will be built
5959
in the future. However, in the meantime, the [provable.tools](https://provable.tools) website is a good
6060
example of how to use these modules to build a web app. Its source code can be found in the
61-
[Aleo SDK](https://github.com/ProvableHQ/sdk) repo in the `website` folder.
61+
[Provable SDK](https://github.com/ProvableHQ/sdk) repo in the `website` folder.

wasm/build.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
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/>.
1616

1717
use std::{fs::File, io::Read, path::Path};
1818

wasm/src/account/address.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
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/>.
1616

1717
use crate::account::{PrivateKey, Signature, ViewKey};
1818

wasm/src/account/compute_key.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
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/>.
1616

1717
use super::PrivateKey;
1818
use crate::{

wasm/src/account/encryptor.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
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/>.
1616

1717
use crate::types::native::{
1818
CiphertextNative,

wasm/src/account/graph_key.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
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/>.
1616

1717
use super::ViewKey;
1818
use crate::types::{Field, native::GraphKeyNative};

wasm/src/account/mod.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
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/>.
1616

1717
pub mod address;
1818
pub use address::*;

0 commit comments

Comments
 (0)