Skip to content

Commit 0dec700

Browse files
Change Aleo SDK to Provable SDK
1 parent 055820a commit 0dec700

26 files changed

+100
-100
lines changed

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

sdk/README.md

Lines changed: 9 additions & 9 deletions
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

wasm/README.md

Lines changed: 1 addition & 1 deletion
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

Lines changed: 4 additions & 4 deletions
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

Lines changed: 4 additions & 4 deletions
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/encryptor.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
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.

wasm/src/account/mod.rs

Lines changed: 4 additions & 4 deletions
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::*;

wasm/src/account/private_key.rs

Lines changed: 4 additions & 4 deletions
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::{
1818
Address,

wasm/src/account/private_key_ciphertext.rs

Lines changed: 4 additions & 4 deletions
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::{Encryptor, PrivateKey};
1818

0 commit comments

Comments
 (0)