create-leo-app 0.7.0 → 0.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-leo-app",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "type": "module",
   "license": "GPL-3.0",
   "collaborators": [

package/template-extension/README.md

@@ -1,4 +0,0 @@
-# Chrome Extension + Aleo
-
-> > [!NOTE]
-> This is an experimental template not recommended for use

package/template-nextjs-ts/README.md

@@ -1,19 +0,0 @@
-This is a [Next.js](https://nextjs.org/) example project showing Aleo
-integration via Web Workers.
-
-This template is based off the default TypeScript configuration from
-[`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app)
-
-## Getting Started
-
-First, run the development server:
-
-```bash
-yarn dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the
-result.
-
-You can start editing the page by modifying `app/page.tsx`. The page
-auto-updates as you edit the file.

package/template-node/README.md

@@ -1,5 +0,0 @@
-# Aleo + Node.js
-
-`npm start`
-
-Recommend Node.js 20+ for best performance.

package/template-node-ts/README.md

@@ -1,5 +0,0 @@
-# Aleo + Node.js + TypeScript
-
-`npm start`
-
-Recommend Node.js 20+ for best performance.

package/template-offline-public-transaction-ts/README.md

@@ -1,52 +0,0 @@
-# Offline Transaction Builder 
-
-## 1. Overview
-### 1.1 Proving Keys for Zero Knowledge Function Execution
-To achieve zero knowledge execution, all Aleo functions require a `ProvingKey` and `VerifyingKey` in order to build a
-zero knowledge ZkSnark proof of execution. If a user does not possess these keys for a function, they are normally
-downloaded from the internet when the function is called.
-
-### 1.2 Key Providers
-They `KeyProvider` interface is designed to allow users to provide their own implementations for providing key material
-to Aleo function executions.
-
-### 1.3 Building Transactions Offline
-
-The `OfflineKeyProvider` enables Transaction Building without connection to the internet.
-
-The `OfflineKeyProvider` and `OfflineSearchParams` are concrete implementations of the `KeyProvider` and `KeySearchParams` 
-interfaces. They are designed to fetch proving key material for Aleo functions from a local machine instead of contacting
-the internet for it. This provides a way to build Aleo execution transactions without being connected to the internet.
-
-This pathway is suitable for use-cases such as hardware wallets or air-gapped machines used
-for building secure transactions.
-
-### 1.4 Assumptions
-
-The key material in this example is assumed to be pre-downloaded onto the machine performing the 
-construction of the offline transaction.
-
-## 2. Usage
-
-### 2.1 Pre-Download the Keys
-First run this command online to download the key material to disk:
-
-`npm start`
-
-Once this command is run, all proving keys for the `transfer_public`, `bond_public`, `unbond_public`, and
-`claim_unbond_public` functions will be downloaded to the `./keys` folder. The machine can then be disconnected from
-the internet and the `OfflineKeyProvider` will search this directory for the function proving keys when building the
-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
-adding the key material yourself.
-
-### 2.2 Build the Transaction Offline
-
-Once the key material is downloaded, turn off your internet connection and run the following command:
-
-`npm start`
-
-You should see the transactions being built and the resulting transaction IDs printed to the console.
-
-## 3. Notes
-
-Node.js 20+ is recommended for best performance.

package/template-react-leo/README.md

@@ -1,90 +0,0 @@
-# React + Aleo + Leo
-
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/fork/github/ProvableHQ/sdk/tree/testnet3/create-leo-app/template-react-leo)
-
-This template provides a minimal setup to get React and Aleo working in Vite
-with HMR and some ESLint rules.
-
-This template includes a Leo program that is loaded by the web app located in
-the `helloworld` directory.
-
-Note: Webpack is currently used for production builds due to a
-[bug](https://github.com/vitejs/vite/issues/13367) with Vite related to nested
-workers.
-
-### Start in development mode
-
-```bash
-npm run dev
-```
-
-Your app should be running on http://localhost:5173/
-
-### Build Leo program
-
-1. Copy the `helloworld/.env.example` to `helloworld/.env` (this will be ignored
-   by Git):
-
-   ```bash
-   cd helloworld
-   cp .env.example .env
-   ```
-
-2. Replace `PRIVATE_KEY=user1PrivateKey` in the `.env` with your own key (you
-   can use an existing one or generate your own at https://provable.tools/account)
-
-3. Follow instructions to install Leo here: https://github.com/ProvableHQ/leo
-
-4. You can edit `helloworld/src/main.leo` and run `leo run` to compile and update the
-   Aleo instructions under `build` which are loaded by the web app.
-
-## Deploy program from web app
-
-> [!WARNING]
-> This is for demonstration purposes or local testing only, in production applications you
-> should avoid building a public facing web app with private key information
-
-Information on generating a private key, seeding a wallet with funds, and finding a spendable record can be found here
-if you are unfamiliar: https://developer.aleo.org/testnet/getting_started/deploy_execute_demo
-
-Aleo programs deployed require unique names, make sure to edit the program's name to something unique in `helloworld/src/main.leo`, `helloworld/program.json`, rename `helloworld/inputs/helloworld.in` and rebuild.
-
-1. In the `worker.js` file modify the privateKey to be an account with available
-   funds
-
-   ```js
-   // Use existing account with funds
-   const account = new Account({
-     privateKey: "user1PrivateKey",
-   });
-   ```
-
-2. (Optional) Provide a fee record manually (located in commented code within `worker.js`)
-
-   If you do not provide a manual fee record, the SDK will attempt to scan for a record starting at the latest block. A simple way to speed this up would be to make a public transaction to this account right before deploying.
-
-3. Run the web app and hit the deploy button
-
-## Production deployment
-
-### Build
-
-`npm run build`
-
-Upload `dist` folder to your host of choice.
-
-### ⚠️ Header warnings
-
-`DOMException: Failed to execute 'postMessage' on 'Worker': SharedArrayBuffer transfer requires self.crossOriginIsolated`
-
-If you get a warning similar to this when deploying your application, you need
-to make sure your web server is configured with the following headers:
-
-```
-Cross-Origin-Opener-Policy: same-origin
-Cross-Origin-Embedder-Policy: require-corp
-```
-
-We've included a `_headers` file that works with some web hosts (e.g. Netlify)
-but depending on your host / server setup you may need to configure the headers
-manually.

package/template-react-managed-worker/README.md

@@ -1,8 +0,0 @@
-# React + Aleo + Managed Worker
-
-> [!NOTE]  
-> This is an experimental template not recommended for use
-
-This template provides a minimal setup to get React and Aleo working in Vite with HMR and some ESLint rules.
-
-Note: Webpack is currently used for production builds due to a [bug](https://github.com/vitejs/vite/issues/13367) with Vite related to nested workers.

package/template-react-ts/README.md

@@ -1,90 +0,0 @@
-# React + Aleo + Leo
-
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/fork/github/ProvableHQ/sdk/tree/testnet3/create-leo-app/template-react)
-
-This template provides a minimal setup to get React and Aleo working in Vite
-with HMR and some ESLint rules.
-
-This template includes a Leo program that is loaded by the web app located in
-the `helloworld` directory.
-
-Note: Webpack is currently used for production builds due to a
-[bug](https://github.com/vitejs/vite/issues/13367) with Vite related to nested
-workers.
-
-### Start in development mode
-
-```bash
-npm run dev
-```
-
-Your app should be running on http://localhost:5173/
-
-### Build Leo program
-
-1. Copy the `helloworld/.env.example` to `helloworld/.env` (this will be ignored
-   by Git):
-
-   ```bash
-   cd helloworld
-   cp .env.example .env
-   ```
-
-2. Replace `PRIVATE_KEY=user1PrivateKey` in the `.env` with your own key (you
-   can use an existing one or generate your own at https://provable.tools/account)
-
-3. Follow instructions to install Leo here: https://github.com/ProvableHQ/leo
-
-4. You can edit `helloworld/src/main.leo` and run `leo run` to compile and update the
-   Aleo instructions under `build` which are loaded by the web app.
-
-## Deploy program from web app
-
-> [!WARNING]
-> This is for demonstration purposes or local testing only, in production applications you
-> should avoid building a public facing web app with private key information
-
-Information on generating a private key, seeding a wallet with funds, and finding a spendable record can be found here
-if you are unfamiliar: https://developer.aleo.org/testnet/getting_started/deploy_execute_demo
-
-Aleo programs deployed require unique names, make sure to edit the program's name to something unique in `helloworld/src/main.leo`, `helloworld/program.json`, rename `helloworld/inputs/helloworld.in` and rebuild.
-
-1. In the `worker.js` file modify the privateKey to be an account with available
-   funds
-
-   ```js
-   // Use existing account with funds
-   const account = new Account({
-     privateKey: "user1PrivateKey",
-   });
-   ```
-
-2. (Optional) Provide a fee record manually (located in commented code within `worker.js`)
-
-   If you do not provide a manual fee record, the SDK will attempt to scan for a record starting at the latest block. A simple way to speed this up would be to make a public transaction to this account right before deploying.
-
-3. Run the web app and hit the deploy button
-
-## Production deployment
-
-### Build
-
-`npm run build`
-
-Upload `dist` folder to your host of choice.
-
-### ⚠️ Header warnings
-
-`DOMException: Failed to execute 'postMessage' on 'Worker': SharedArrayBuffer transfer requires self.crossOriginIsolated`
-
-If you get a warning similar to this when deploying your application, you need
-to make sure your web server is configured with the following headers:
-
-```
-Cross-Origin-Opener-Policy: same-origin
-Cross-Origin-Embedder-Policy: require-corp
-```
-
-We've included a `_headers` file that works with some web hosts (e.g. Netlify)
-but depending on your host / server setup you may need to configure the headers
-manually.