diff --git a/documentation/concepts/advanced/intro-to-zksnark/00_overview.md b/documentation/concepts/advanced/00_intro_to_zksnark.md similarity index 100% rename from documentation/concepts/advanced/intro-to-zksnark/00_overview.md rename to documentation/concepts/advanced/00_intro_to_zksnark.md diff --git a/documentation/concepts/advanced/dive-into-avm/00_overview.md b/documentation/concepts/advanced/01_overview.md similarity index 98% rename from documentation/concepts/advanced/dive-into-avm/00_overview.md rename to documentation/concepts/advanced/01_overview.md index d0d8f0f5..935607b2 100644 --- a/documentation/concepts/advanced/dive-into-avm/00_overview.md +++ b/documentation/concepts/advanced/01_overview.md @@ -18,7 +18,7 @@ It was formalised and implemented in the Aleo Network as [ARC-0002](https://gith ## **AVM’s Architecture and Design** -The AVM is virtual machine that operates on a last-in, first-out (LIFO) principle where data is stacked and the most recently added data is the first to be accessed or removed. This design is conducive to the execution of complex arithmetic circuits that are essential for the privacy-preserving features of Aleo. The AVM's architecture is designed to support the execution of private applications by leveraging zero-knowledge proofs. It uses Leo (high-level programming language), which compiles down into an intermediate representation known as AVM opcodes. These opcodes are then used to construct the R1CS, which are essential for generating zero-knowledge proofs. Check the full list [here](../../../guides/aleo/04_opcodes.md) +The AVM is virtual machine that operates on a last-in, first-out (LIFO) principle where data is stacked and the most recently added data is the first to be accessed or removed. This design is conducive to the execution of complex arithmetic circuits that are essential for the privacy-preserving features of Aleo. The AVM's architecture is designed to support the execution of private applications by leveraging zero-knowledge proofs. It uses Leo (high-level programming language), which compiles down into an intermediate representation known as AVM opcodes. These opcodes are then used to construct the R1CS, which are essential for generating zero-knowledge proofs. Check the full list [here](../../guides/aleo/04_opcodes.md) The AVM architecture can be broken down into several key components and characteristics: diff --git a/documentation/concepts/advanced/dive-into-avm/01_aleo_account_keys.md b/documentation/concepts/advanced/02_aleo_account_keys.md similarity index 100% rename from documentation/concepts/advanced/dive-into-avm/01_aleo_account_keys.md rename to documentation/concepts/advanced/02_aleo_account_keys.md diff --git a/documentation/concepts/advanced/dive-into-avm/02_r1cs.md b/documentation/concepts/advanced/03_r1cs.md similarity index 100% rename from documentation/concepts/advanced/dive-into-avm/02_r1cs.md rename to documentation/concepts/advanced/03_r1cs.md diff --git a/documentation/concepts/advanced/dive-into-avm/03_inclusion_proof.md b/documentation/concepts/advanced/04_inclusion_proof.md similarity index 100% rename from documentation/concepts/advanced/dive-into-avm/03_inclusion_proof.md rename to documentation/concepts/advanced/04_inclusion_proof.md diff --git a/documentation/concepts/advanced/dive-into-avm/images/aleo_key_generation.png b/documentation/concepts/advanced/images/aleo_key_generation.png similarity index 100% rename from documentation/concepts/advanced/dive-into-avm/images/aleo_key_generation.png rename to documentation/concepts/advanced/images/aleo_key_generation.png diff --git a/documentation/concepts/advanced/dive-into-avm/images/avm_execution_flow_overview.png b/documentation/concepts/advanced/images/avm_execution_flow_overview.png similarity index 100% rename from documentation/concepts/advanced/dive-into-avm/images/avm_execution_flow_overview.png rename to documentation/concepts/advanced/images/avm_execution_flow_overview.png diff --git a/documentation/concepts/advanced/dive-into-avm/images/avs_global_state.png b/documentation/concepts/advanced/images/avs_global_state.png similarity index 100% rename from documentation/concepts/advanced/dive-into-avm/images/avs_global_state.png rename to documentation/concepts/advanced/images/avs_global_state.png diff --git a/documentation/concepts/beginner/03A_transaction_fees.md b/documentation/concepts/beginner/03A_transaction_fees.md deleted file mode 100644 index a24a0d10..00000000 --- a/documentation/concepts/beginner/03A_transaction_fees.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: transaction_fees -title: Transaction Fees -sidebar_label: Transaction Fees ---- - -# Transaction Fees - -A **transaction fee** is a fee that is required in order to process a transaction on the Aleo network. Currently, there are two types of transaction fees that correspond to each transaction type: **deploy** and **execute**. - -## Aleo Credits Denomination Table - -|Denomination|Size of Transaction|Value|Example| -|:-:|:-:|:-:|:-:| -|`microcredit`|Byte|1|Smallest denomination| -|`millicredit`|Kilobyte (KB)|1000 microcredits|Most transactions average between 3 and 10 millicredits| -|`credit`|Megabyte (MB)|1000 millicredits|Largest denomination| - -Note that transaction sizes are averages using [Big _O_ notation (on the order of)](https://en.wikipedia.org/wiki/Big_O_notation). - -# Types of Transaction Fees - -## Deploy Transaction Fee -A fee incurred when deploying an application on the Aleo blockchain - -### Structure - -|Part of Deploy Transaction|Size| Multiplier|Cost| -|:-:|:-:|:-:|:-:| -|`Transaction wrapper`|0 KB|1|0 millicredits| -|`Transition wrapper`|0 KB|1|0 millicredits| -|`Verifying key`|1 KB|2|2 millicredits| -|`Certificate`|1 MB|2|2 millicredits| -|`Program bytecode`|1 KB|1|1 millicredit| - -|Total|Size|Multiplier|Total cost| -|:-:|:-:|:-:|:-:| -|`Transaction -> Transition`|5 KB|1000 *|5 credits| - - -#### Notes -* To prevent bad actors from spamming the network with superfluous transactions, a variable **Deploy Transaction Multiplier** will be added to all deploy transactions. - -## Execute Transaction Fee -A fee incurred when executing an application on the Aleo blockchain - -### Structure (minimum cost example) - -|Part of Execute Transaction|Size| Multiplier|Cost| -|:-:|:-:|:-:|:-:| -|`Transaction wrapper`|0 KB|1|0 millicredits| -|`Transition wrapper`|0 KB|1|0 millicredits| -|`Input`|1 KB|2|2 millicredits| -|`Output`|1 KB|2|2 millicredits| -|`Proof`|1 KB|1|1 millicredit| - -|Total|Size|Multiplier|Total cost| -|:-:|:-:|:-:|:-:| -|`Transaction -> Transition`|5 KB|1|5 millicredits| - -### Structure (maximum cost example) - -|Part of Execute Transaction|Size| Multiplier|Cost| -|:-:|:-:|:-:|:-:| -|`Transaction wrapper`|1 KB|65|65 millicredits| -|`Transition wrapper`|1 MB|32|32 credits| -|`Input`|1 KB|16 * 32|512 millicredits| -|`Output`|1 KB| 16 * 32|512 millicredits| -|`Proof`|1 KB|1|1 millicredit| - -|Total|Size|Multiplier|Total cost| -|:-:|:-:|:-:|:-:| -|`Transaction -> Transition`|32 MB|1|32 credits| - -Notes -* The minimum execute transaction fee may increase to prevent spamming; it is currently stable between 3 and 5 millicredits for a basic `credits.aleo` transfer - - - diff --git a/documentation/concepts/beginner/00_accounts.md b/documentation/concepts/fundamentals/00_accounts.md similarity index 100% rename from documentation/concepts/beginner/00_accounts.md rename to documentation/concepts/fundamentals/00_accounts.md diff --git a/documentation/concepts/beginner/01_programs.md b/documentation/concepts/fundamentals/01_programs.md similarity index 100% rename from documentation/concepts/beginner/01_programs.md rename to documentation/concepts/fundamentals/01_programs.md diff --git a/documentation/concepts/beginner/02_records.md b/documentation/concepts/fundamentals/02_records.md similarity index 100% rename from documentation/concepts/beginner/02_records.md rename to documentation/concepts/fundamentals/02_records.md diff --git a/documentation/concepts/fundamentals/03A_transaction_fees.md b/documentation/concepts/fundamentals/03A_transaction_fees.md new file mode 100644 index 00000000..9e6e4686 --- /dev/null +++ b/documentation/concepts/fundamentals/03A_transaction_fees.md @@ -0,0 +1,38 @@ +--- +id: transaction_fees +title: Transaction Fees +sidebar_label: Transaction Fees +--- + +# Transaction Fees + +A **transaction fee** is a fee that is required in order to process a transaction on the Aleo network. Below, we describe the way in which **Deploy** and **Execute** transactions are priced. At the time of writing, puzzle solutions are free. + +## Aleo Credits Denomination Table + +|Denomination|Size of Transaction|Value|Example| +|:-:|:-:|:-:|:-:| +|`microcredit`|Byte|1|Smallest denomination| +|`millicredit`|Kilobyte (KB)|1000 microcredits|Most transactions average between 3 and 10 millicredits| +|`credit`|Megabyte (MB)|1000 millicredits|Largest denomination| + +## Types of Transaction Fees +### Deployment Base Fee +This is what you pay for deploying a program to the Aleo network. Deployment fees consist of the following parts: + +- There is a size cost, determined by the amount of raw bytes of your program. +- There is a namespace cost, the smaller your program name the more you pay. There is no namespace cost if your program name is 10 characters or longer. +- There is a synthesize cost to process your program. The more complicated operations which your program has, the more time it takes for the network to convert this to a circuit to create zero knowledge proofs for. + +### Execution Base Fee +This is what you pay for executing program functions on the Aleo network. + +- There is a size cost, determined by the amount of raw bytes of your program. A quadratic fee kicks in above 5 KB. +- There is a finalize cost, determined by the amount of operations in your function's finalize scope. +- There is no execution cost, because verifying the associated zero knowledge proof is cheap. + +### Priority Fee +Priority fees are optional fees which can help speed up the processing of your transaction during high traffic. They are not yet supported, but will soon be. + +### Estimating fees +The fee determination logic is defined in [a file called cost.rs](https://github.com/ProvableHQ/snarkVM/blob/mainnet/synthesizer/process/src/cost.rs#L26). If you want to quickly estimate fees using a website, [provable.tools](https://www.provable.tools/develop) has some limited support. \ No newline at end of file diff --git a/documentation/concepts/beginner/03_transactions.md b/documentation/concepts/fundamentals/03_transactions.md similarity index 100% rename from documentation/concepts/beginner/03_transactions.md rename to documentation/concepts/fundamentals/03_transactions.md diff --git a/documentation/concepts/beginner/04_transitions.md b/documentation/concepts/fundamentals/04_transitions.md similarity index 100% rename from documentation/concepts/beginner/04_transitions.md rename to documentation/concepts/fundamentals/04_transitions.md diff --git a/documentation/concepts/beginner/05_blocks.md b/documentation/concepts/fundamentals/05_blocks.md similarity index 100% rename from documentation/concepts/beginner/05_blocks.md rename to documentation/concepts/fundamentals/05_blocks.md diff --git a/documentation/concepts/beginner/06_public_private.md b/documentation/concepts/fundamentals/06_public_private.md similarity index 99% rename from documentation/concepts/beginner/06_public_private.md rename to documentation/concepts/fundamentals/06_public_private.md index 59fc9529..437ca355 100644 --- a/documentation/concepts/beginner/06_public_private.md +++ b/documentation/concepts/fundamentals/06_public_private.md @@ -9,6 +9,7 @@ sidebar_label: Public vs. Private State The concept of Zero Knowledge proofs was first introduced in 1985 in the paper [The Knowledge Complexity of Interactive Proof Systems](https://epubs.siam.org/doi/10.1137/0218012?utm_source=the+new+stack&utm_medium=referral&utm_content=inline-mention&utm_campaign=tns+platform). However, it is only in recent years that the groundbreaking technology has been feasible to be applicable to blockchains. + Zcash was one of the earliest chains to utilize the power of zero knowledge proofs to provide privacy to an account's balance. Unlike traditional cryptocurrencies like Bitcoin, where transaction details are publicly visible on the blockchain, Zcash enables users to shield their transactions, rendering them completely opaque to outside observers. It utilizes zk-SNARKs (Zero-Knowledge Succinct Non-Interactive Argument of Knowledge), a type of zero-knowledge proof system that allows parties to verify the validity of a computation without revealing the underlying data. In even more recent times, we have seen several Ethereum virtual machine-compatible Layer-2 chains that have employed zero-knowledge cryptography techniques to solve Ethereum's scalability issues. They use zk-rollups, which compute multiple state changes off-chain, followed by posting the summary of those transactions and proofs on-chain. This helps to reduce transaction fees significantly. However, all of them utilize zero-knowledge technology mainly for scalability reasons. diff --git a/documentation/concepts/beginner/07_async.md b/documentation/concepts/fundamentals/07_async.md similarity index 100% rename from documentation/concepts/beginner/07_async.md rename to documentation/concepts/fundamentals/07_async.md diff --git a/documentation/concepts/beginner/images/account_vs_utxo.png b/documentation/concepts/fundamentals/images/account_vs_utxo.png similarity index 100% rename from documentation/concepts/beginner/images/account_vs_utxo.png rename to documentation/concepts/fundamentals/images/account_vs_utxo.png diff --git a/documentation/concepts/beginner/images/aleo.jpeg b/documentation/concepts/fundamentals/images/aleo.jpeg similarity index 100% rename from documentation/concepts/beginner/images/aleo.jpeg rename to documentation/concepts/fundamentals/images/aleo.jpeg diff --git a/documentation/concepts/beginner/images/aleo_ledger.png b/documentation/concepts/fundamentals/images/aleo_ledger.png similarity index 100% rename from documentation/concepts/beginner/images/aleo_ledger.png rename to documentation/concepts/fundamentals/images/aleo_ledger.png diff --git a/documentation/concepts/beginner/images/ethereum_storage.png b/documentation/concepts/fundamentals/images/ethereum_storage.png similarity index 100% rename from documentation/concepts/beginner/images/ethereum_storage.png rename to documentation/concepts/fundamentals/images/ethereum_storage.png diff --git a/documentation/concepts/beginner/images/ethereum_world_state.png b/documentation/concepts/fundamentals/images/ethereum_world_state.png similarity index 100% rename from documentation/concepts/beginner/images/ethereum_world_state.png rename to documentation/concepts/fundamentals/images/ethereum_world_state.png diff --git a/documentation/concepts/beginner/images/record.png b/documentation/concepts/fundamentals/images/record.png similarity index 100% rename from documentation/concepts/beginner/images/record.png rename to documentation/concepts/fundamentals/images/record.png diff --git a/documentation/concepts/beginner/images/transaction_in_aleo.png b/documentation/concepts/fundamentals/images/transaction_in_aleo.png similarity index 100% rename from documentation/concepts/beginner/images/transaction_in_aleo.png rename to documentation/concepts/fundamentals/images/transaction_in_aleo.png diff --git a/documentation/concepts/beginner/images/utxo.png b/documentation/concepts/fundamentals/images/utxo.png similarity index 100% rename from documentation/concepts/beginner/images/utxo.png rename to documentation/concepts/fundamentals/images/utxo.png diff --git a/documentation/concepts/network/network/consensus.md b/documentation/concepts/network/network/consensus.md index 6f051b96..4d5e8720 100644 --- a/documentation/concepts/network/network/consensus.md +++ b/documentation/concepts/network/network/consensus.md @@ -16,18 +16,18 @@ Check this [FAQs](https://aleo.org/faq/) out in regards of the groups mentioned Everyone can become a staker by locking up their Aleo Credits for a certain period of time to support the security of the Aleo Network. While the minimum amount to stake is 1 AC, stakers will only start earning rewards once they have staked at least 10 ACs. Stakers help lower the barriers to becoming a validator by delegating their stakes to validators of their choice. - -Learn more about **stakers** at [here](./stakers). + +Learn more about **stakers** at [here](./stakers.md). Provers are required to run specialized GPUs and CPUs to generate solutions in SNARK proofs for PoSW (Proof-of-Succinct-Work) coinbase puzzles. They are rewarded based on their efficiency and effectiveness in generating solutions to the puzzles. It's important to note that provers do not produce blocks, but they are incentivized to improve the process of generating proofs, reducing costs, and decreasing latency for program execution. -Learn more about **provers** at [here](./provers). +Learn more about **provers** at [here](./provers.md). Validators play a crucial role in securing the network through AleoBFT (to be discussed further below) and must have at least 10 million AC of stakes to get started. The main function of validators is to verify ZK proofs and validate transactions before including them in a confirmed block. -Learn more about **validators** at [here](./validators). +Learn more about **validators** at [here](./validators.md). + - ## AleoBFT AleoBFT is a new hybrid architecture for consensus. It is a DAG-based BFT protocol inspired by Narwhal and Bullshark. It incentivises validators to preserve network liveness and provers to scale proving capacity for Aleo ecosystem. diff --git a/documentation/concepts/network/zkcloud/snarkos.md b/documentation/concepts/network/zkcloud/snarkos.md index 0755a4e6..db2fc29f 100644 --- a/documentation/concepts/network/zkcloud/snarkos.md +++ b/documentation/concepts/network/zkcloud/snarkos.md @@ -13,12 +13,12 @@ An Aleo node can be run in three modes. - -- [Client](../network/client) -- [Prover](../network/provers) -- [Validator](../network/validators) - +- [Client](../network/client.md) +- [Prover](../network/provers.md) +- [Validator](../network/validators.md) + + ## Who uses snarkOS ? Everyone involved in Aleo uses snarkOS both to submit transactions and to fetch their data. diff --git a/documentation/contribute/00_contribution_guidelines.md b/documentation/contribute/00_contribution_guidelines.md index a85e4c79..845055b3 100644 --- a/documentation/contribute/00_contribution_guidelines.md +++ b/documentation/contribute/00_contribution_guidelines.md @@ -30,14 +30,13 @@ Once a proposal is up: 5. The relevant parties should complete the implementation. Updates can be made to the ARC as needed through new PRs, which do not need votes. 6. Once the implementation is finalized, the status will change from "approved" to "completed." - + ### Contributing to Aleo -Every component that forms Aleo is open-sourced and welcomes contributions of all kinds including [this documentation](./documentation_contribute). Each component has its own specific contribution guidelines, which are provided below for easy reference: -- [DevDocs](./documentation_contribute) - This developer documentation +Every component that forms Aleo is open-sourced and welcomes contributions of all kinds including [this documentation](./01_documentation_contribute.md). Each component has its own specific contribution guidelines, which are provided below for easy reference: +- [DevDocs](./01_documentation_contribute.md) - This developer documentation - [Leo](https://docs.leo-lang.org/leo/resources#contributing) - Rust-based DSL to write programs on Aleo -- [Provable SDK](https://github.com/ProvableHQ/sdk/tree/testnet3/sdk) - Javascript/Typescript tools for creating zero knowledge apps -- [Create-leo-app](https://github.com/ProvableHQ/sdk/tree/testnet3/create-leo-app) - Scaffolding your first Aleo project +- [Provable SDK](https://github.com/ProvableHQ/sdk/tree/mainnet/sdk) - Javascript/Typescript tools for creating zero knowledge apps +- [Create-leo-app](https://github.com/ProvableHQ/sdk/tree/mainnet/create-leo-app) - Scaffolding your first Aleo project - [Aleo Instruction](../guides/aleo/00_aleo_overview.md) - IR that Leo language compiles into -- [SnarkOS](./snarkos_contribute) - The operating system or blockchain node client of Aleo -- [SnarkVM](./snarkvm_contribute) - The virtual machine that performs verifiable computation - \ No newline at end of file +- [SnarkOS](./02_snarkos_contribute.md) - The operating system or blockchain node client of Aleo +- [SnarkVM](./03_snarkvm_contribute.md) - The virtual machine that performs verifiable computation diff --git a/documentation/contribute/01_documentation_contribute.md b/documentation/contribute/01_documentation_contribute.md index d17a2f37..b7eaf45e 100644 --- a/documentation/contribute/01_documentation_contribute.md +++ b/documentation/contribute/01_documentation_contribute.md @@ -3,7 +3,7 @@ id: documentation_contribute title: DevDocs Contribution sidebar_label: DevDocs Contribution --- - + Welcome to the Aleo DevDocs contribution guide! We invite you to help improve our documentation, making it more comprehensive and up-to-date. Your contributions, big or small, are valuable in enhancing the Aleo ecosystem for developers. This guide will walk you through the process of contributing effectively to our documentation. ## Providing Feedback @@ -77,4 +77,3 @@ Your feedback helps us identify areas for improvement and ensures the documentat If you have any questions or need assistance, please don't hesitate to open an issue in the [welcome](https://github.com/AleoNet/welcome) repository or reach out to the maintainers. Thank you for contributing to the Aleo documentation! - \ No newline at end of file diff --git a/documentation/guides/aleo/03_language.md b/documentation/guides/aleo/03_language.md index f326d496..72d05179 100644 --- a/documentation/guides/aleo/03_language.md +++ b/documentation/guides/aleo/03_language.md @@ -297,7 +297,7 @@ Aleo instructions currently only support fixed-length static arrays. ### Record -A [record](../../concepts/beginner/02_records.md) type is declared as `record {name}:`. +A [record](../../concepts/fundamentals/02_records.md) type is declared as `record {name}:`. Records contain component declarations `{name} as {type}.{visibility};`. Record data structures must contain the `owner` declaration as shown below. When passing a record as input to a program function the `_nonce as group.{visibility}` declaration is also required. diff --git a/documentation/guides/aleo/05_commands.md b/documentation/guides/aleo/05_commands.md index c5b6d004..4ed52119 100644 --- a/documentation/guides/aleo/05_commands.md +++ b/documentation/guides/aleo/05_commands.md @@ -20,7 +20,7 @@ You can print the list of commands by running `snarkvm --help` [//]: # (5. [aleo deploy](#6-aleo-deploy)) The Aleo private key, view key, and address will be printed to console. -See [`concepts/accounts`](../../concepts/beginner/00_accounts.md) for more information. +See [`concepts/accounts`](../../concepts/fundamentals/00_accounts.md) for more information. ## `snarkvm new` diff --git a/documentation/guides/aleo/07_tooling.md b/documentation/guides/aleo/07_tooling.md index b382b52b..3e1f92c1 100644 --- a/documentation/guides/aleo/07_tooling.md +++ b/documentation/guides/aleo/07_tooling.md @@ -23,10 +23,10 @@ Aleo instructions support for Sublime's LSP plugin is provided through a languag ### Install - + 1. Install [LSP](https://packagecontrol.io/packages/LSP) and [LSP-leo](https://packagecontrol.io/packages/LSP-leo) from Package Control. 2. Restart Sublime. - + ### Usage diff --git a/documentation/guides/introduction/00_getting_started.md b/documentation/guides/introduction/00_getting_started.md index 5c90e4c1..03cf6141 100644 --- a/documentation/guides/introduction/00_getting_started.md +++ b/documentation/guides/introduction/00_getting_started.md @@ -93,12 +93,12 @@ To verify if you have snarkOS, open your terminal and type `snarkos`. You should ![snarkOS](./images/snarkos-cli.png) - + ## 3. Next Steps Once you have successfully completed the installation of both Leo and snarkOS, you are ready to begin your journey with Aleo. -To get started quickly and see Aleo in action, we recommend proceeding to the [Quick Start Guide](./quick_start). This guide will walk you through creating your first Aleo application, deploying it to the network, and executing it. This hands-on experience will give you a practical understanding of the Aleo platform's core features and workflow. +To get started quickly and see Aleo in action, we recommend proceeding to the [Quick Start Guide](./00_quick_start.md). This guide will walk you through creating your first Aleo application, deploying it to the network, and executing it. This hands-on experience will give you a practical understanding of the Aleo platform's core features and workflow. + - diff --git a/documentation/guides/introduction/00_quick_start.md b/documentation/guides/introduction/00_quick_start.md index 8602b445..08139b59 100644 --- a/documentation/guides/introduction/00_quick_start.md +++ b/documentation/guides/introduction/00_quick_start.md @@ -5,13 +5,13 @@ sidebar_label: Quick Start --- Learn how to deploy and execute a basic "hello world!" program on Aleo's network using Leo and snarkOS. - + ## 1. Prerequisites -Make sure you have both `Leo` and `snarkOS` installed on your machine. If you have not installed these yet, you can do so by following the instructions [here](./getting_started). +Make sure you have both `Leo` and `snarkOS` installed on your machine. If you have not installed these yet, you can do so by following the instructions [here](./00_getting_started.md). + - ## 2. Generate your test keys and wallet address @@ -34,7 +34,7 @@ Save your **Address**, **View Key**, and **Private Key** in a safe place, you'll ::: ## 3. Seeding your wallet with credits - + To seed your wallet, you'll need to request credits from faucet provided by the ecosystem wallets at: * [Leo Wallet Discord](https://www.leo.app/) (Scroll to bottom of the landing page to find Discord invite) @@ -43,7 +43,7 @@ To seed your wallet, you'll need to request credits from faucet provided by the The credits received from faucet will be public credits, which means they are publicly visible on the Aleo network before converting to private credits. - + :::tip While waiting for the credits to be sent to your wallet, you can proceed to the next step of creating a Leo application. @@ -103,9 +103,11 @@ leo deploy ``` You should have seen a confirmation that your Aleo application was deployed in the form of a transaction ID that looks like the following `at1rkkpqu5k4rt86zzccczw6cxeyvrl7hxydvvv7dhl7zr7p9w40c8s70kwm8`. Copy your transaction ID to view the details of your deployment transaction on the Aleo block explorers: - + - [Provable Explorer](https://testnet.explorer.provable.com/) + - [Aleoscan](https://testnet.aleoscan.io/) + - [Aleo123](https://testnet.aleo123.io/) - [Aleo.Info](https://testnet.aleo.info/) @@ -113,7 +115,7 @@ You should have seen a confirmation that your Aleo application was deployed in t Finally, it is time to execute the application you just deployed! - + Make sure you are in the root of your Leo application and paste the following command in your terminal diff --git a/documentation/guides/sdk/00_sdk_overview.md b/documentation/guides/sdk/00_sdk_overview.md index b29798d8..f8c343d5 100644 --- a/documentation/guides/sdk/00_sdk_overview.md +++ b/documentation/guides/sdk/00_sdk_overview.md @@ -1,5 +1,5 @@ --- -id: sdk +id: overview title: Provable SDK sidebar_label: Overview --- @@ -77,9 +77,9 @@ The official Aleo Python SDK providing tools for creating zero knowledge apps. I Both libraries are in an early development stage. They can be installed through `pip install aleo` respectively `pip install zkml`. The [documentation on the aleo library](./python/00_aleo_sdk.md) and the [documentation on the zkml library](./python/01_zkml_transpiler.md) provide more information on installation and usage. - + Source: [`python-sdk`](https://github.com/provablehq/python-sdk) - + ## 📚 Documentation diff --git a/documentation/guides/sdk/create-leo-app/01_create_leo_app.md b/documentation/guides/sdk/create-leo-app/01_create_leo_app.md index 9825285f..b65a92a4 100644 --- a/documentation/guides/sdk/create-leo-app/01_create_leo_app.md +++ b/documentation/guides/sdk/create-leo-app/01_create_leo_app.md @@ -21,10 +21,10 @@ npm install npm run install-leo npm run dev ``` - + This installs all the required modules and also Leo, our statically-typed programming language built for writing private applications. Lastly, we've initialized a local instance of your React application at http://localhost:5173. - + `src/App.jsx` contains the main body of your React application. The `helloworld` folder is your Leo program. This is where you’ll use Leo. @@ -33,10 +33,11 @@ The `helloworld` folder is your Leo program. This is where you’ll use Leo. ## 3. Execute `helloworld.aleo` + Navigate to http://localhost:5173 and open up the developer console in your browser - + Hit “execute helloworld.aleo”. Execution should happen locally and you should see an output pop up. @@ -60,11 +61,11 @@ Write down your private key, view key, and public address in a safe place. Treat ### Faucet Once you have your account, use our faucet to get some Aleo credits! Our ecosystem wallets have faucets that you can use to get credits. - + * [Leo Wallet Discord](https://www.leo.app/) (Scroll to bottom of the landing page to find Discord invite) * [Puzzle Wallet Faucet](https://dev.puzzle.online/faucet) * [Soter Wallet Faucet](https://faucetbeta.sotertech.io/) - + ### Leo & `helloworld` diff --git a/documentation/guides/sdk/python/00_aleo_sdk.md b/documentation/guides/sdk/python/00_aleo_sdk.md index 8df034af..fe33b3f5 100644 --- a/documentation/guides/sdk/python/00_aleo_sdk.md +++ b/documentation/guides/sdk/python/00_aleo_sdk.md @@ -4,9 +4,9 @@ title: Provable Python SDK sidebar_label: Provable Python SDK --- - + [![github]](https://github.com/provablehq/python-sdk/tree/master/sdk) - + [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github @@ -29,9 +29,8 @@ Ensure you have Python 3.11 or newer installed. If your operating system is supp pip3 install aleo ``` - -Alternatively, you can also install from a `.whl` file, either from the [GitHub repository](https://github.com/provablehq/python-sdk/tree/master/sdk/target/wheels), or by building it yourself. For the installation, use a command like this: - +For the installation, use a command like this: + ```bash pip3 install aleo-0.0.3-cp311-cp311-macosx_11_0_arm64.whl @@ -47,13 +46,13 @@ private_key = aleo.PrivateKey() print(private_key.to_string()) ``` - + ### Build Instructions To build it, first clone the [GitHub repository](https://github.com/provablehq/python-sdk/tree/master/sdk). Then, run the following command: ```bash bash build.sh ``` - + After successful building, you will find a new `.whl` file in the `target/wheels` directory that you can install using the command from above. diff --git a/documentation/guides/sdk/python/01_zkml_transpiler.md b/documentation/guides/sdk/python/01_zkml_transpiler.md index 7324a191..e076edd6 100644 --- a/documentation/guides/sdk/python/01_zkml_transpiler.md +++ b/documentation/guides/sdk/python/01_zkml_transpiler.md @@ -4,9 +4,9 @@ title: zkml transpiler sidebar_label: zkml Transpiler --- - + [![github]](https://github.com/provablehq/python-sdk/tree/master/zkml) - + [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github @@ -50,17 +50,17 @@ You can install the `zkml` Python library from PyPI using the following command: pip3 install zkml ``` - + Note: On some systems, you may need to use `pip` instead of `pip3`. Alternatively, you can also install through the `.whl` file or in editable mode from the [GitHub repository](https://github.com/provablehq/python-sdk/tree/master/zkml). - + ### Usage - + Below is a brief description of the classes and functions provided by the library. Detailed documentation is in progress and will be available soon. We encourage you to also check out the [examples on GitHub](https://github.com/provablehq/python-sdk/tree/master/zkml/examples). - + * In a first step, you can receive an object of the class `zkml.LeoTranspiler(model, validation_data)` * For the `model` parameter, pass the trained scikit-learn model @@ -78,7 +78,7 @@ We encourage you to also check out the [examples on GitHub](https://github.com/p ## Building Python Apps - + Please check out the [examples on GitHub](https://github.com/provablehq/python-sdk/tree/master/zkml/examples). Further documentation and tutorials as to how to use the `zkml` Python library will follow soon. - + diff --git a/documentation/guides/sdk/typescript/00_sdk_overview.md b/documentation/guides/sdk/typescript/00_sdk_overview.md index 2319a344..80d2e17c 100644 --- a/documentation/guides/sdk/typescript/00_sdk_overview.md +++ b/documentation/guides/sdk/typescript/00_sdk_overview.md @@ -3,11 +3,11 @@ id: overview title: Javascript/Typescript sidebar_label: Javascript/Typescript --- - + Provable SDK - + ## Tools for Building Zero Knowledge Web Apps @@ -682,12 +682,12 @@ A full example of this implementation can be found [here](https://github.com/pro The official token of operation of the Aleo Network are Aleo credits. Aleo credits are used to pay all fees for program execution on the Aleo network. - + Aleo credits are defined in the [credits.aleo](https://explorer.aleo.org/program/credits.aleo) program. This program is deployed to the Aleo Network and defines data structures representing Aleo credits and the functions used to manage them. - + There are two ways to hold Aleo credits. @@ -859,13 +859,13 @@ representing a user. A straightforward example of a usage of records in a program can be demonstrated by explaining the process of private value transfers of official Aleo credits on the Aleo network. - + Aleo credits are the official token in which all on-chain execution and deployment fees are paid. Credits can be public or private. Private credits are represented by the `credits` record in the [credits.aleo](https://explorer.aleo.org/programs/credits.aleo) program. - + ``` record credits: diff --git a/documentation/guides/sdk/wasm/00_wasm_installation.md b/documentation/guides/sdk/wasm/00_wasm_installation.md index 3accedea..c5976deb 100644 --- a/documentation/guides/sdk/wasm/00_wasm_installation.md +++ b/documentation/guides/sdk/wasm/00_wasm_installation.md @@ -4,10 +4,11 @@ title: Wasm sidebar_label: Installation --- - + Create Leo App Aleo-Wasm + [![github]](https://github.com/provablehq/sdk) [![crates-io]](https://crates.io/crates/aleo-wasm) [![docs-rs]](https://docs.rs/aleo-wasm/latest/aleo-wasm/) @@ -31,7 +32,7 @@ Functionality exposed by this crate includes: * Aleo primitives such as `Records`, `Programs`, and `Transactions` and their associated helper methods * A `ProgramManager` object that contains methods for authoring, deploying, and interacting with Aleo programs -More information on these concepts can be found at the [Aleo Developer Hub](../../../concepts/beginner/00_accounts.md). +More information on these concepts can be found at the [Aleo Developer Hub](../../../concepts/fundamentals/00_accounts.md). ## Usage diff --git a/documentation/references/01_faqs.md b/documentation/references/01_faqs.md index 9dff5b55..630c1f74 100644 --- a/documentation/references/01_faqs.md +++ b/documentation/references/01_faqs.md @@ -120,7 +120,7 @@ Ethereum introduced programmability but still didn’t offer privacy. Some projects like ZCast offered privacy but didn’t provide programmability. Aleo provides both privacy and programmability. - + ## Where can I watch talks and videos? * Coinbase BUIDL - [**Learning LEO | Coding Private Application with ZK Cryptography**](https://youtu.be/LJXjtthDl6I) @@ -137,7 +137,7 @@ Aleo provides both privacy and programmability. ## What are the Aleo's social accounts? - + [//]: # (disabling markdown checks for twitter links) 👾 | Discord ~ **https://discord.gg/aleo** @@ -146,7 +146,7 @@ Aleo provides both privacy and programmability. 🤝 | Community X (Twitter) ~ @aleocommunity ~ **https://twitter.com/aleocommunity** - + 🐙 | GitHub ~ **https://github.com/AleoNet** diff --git a/documentation/references/02_glossary.md b/documentation/references/02_glossary.md index ea1c800e..82e6a2e7 100644 --- a/documentation/references/02_glossary.md +++ b/documentation/references/02_glossary.md @@ -6,7 +6,7 @@ title: Glossary ### Record Serial Number A record serial number is the evaluation of a PRF on a spent record's serial number nonce and corresponding secret key. -This means every record has a unique serial number, which will allow the Aleo network to prevent [double spends](../concepts/beginner/02_records.md#double-spends) without revealing any information about the record contents. +This means every record has a unique serial number, which will allow the Aleo network to prevent [double spends](../concepts/fundamentals/02_records.md#double-spends) without revealing any information about the record contents. ### Record Commitment diff --git a/documentation/references/apis/00_aleo_public_api.md b/documentation/references/apis/00_aleo_public_api.md index fb9f6936..3f9cacf6 100644 --- a/documentation/references/apis/00_aleo_public_api.md +++ b/documentation/references/apis/00_aleo_public_api.md @@ -8,12 +8,14 @@ sidebar_label: Aleo Public API The Aleo public API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). To query the network, make a request to Aleo public API by Provable. - + | URL | |------------------| | https://api.explorer.provable.com/v1/{network} | + Simply replace `{network}` in the base URL with either `testnet` or `mainnet` to query the desired network. -For example, you can [retrieve the current block height](https://api.explorer.provable.com/v1/testnet/block/height/latest). \ No newline at end of file +For example, you can [retrieve the current block height](https://api.explorer.provable.com/v1/testnet/block/height/latest). + \ No newline at end of file diff --git a/documentation/references/apis/03_latest_block.md b/documentation/references/apis/03_latest_block.md index 54725cbe..21203cab 100644 --- a/documentation/references/apis/03_latest_block.md +++ b/documentation/references/apis/03_latest_block.md @@ -17,5 +17,5 @@ None ### Response | Parameter | Type | Description | |:---------:|:-------------------------------------:|:----------------:| -| `result` | [object](../../concepts/beginner/05_blocks.md) | The latest block | +| `result` | [object](../../concepts/fundamentals/05_blocks.md) | The latest block | diff --git a/documentation/references/apis/03_latest_state_root.md b/documentation/references/apis/03_latest_state_root.md index ae0179ff..ae81ad17 100644 --- a/documentation/references/apis/03_latest_state_root.md +++ b/documentation/references/apis/03_latest_state_root.md @@ -17,5 +17,5 @@ None ### Response | Parameter | Type | Description | |:---------:|:-------------------------------------:|:---------------------:| -| `result` | [string](../../concepts/beginner/05_blocks.md) | The latest state root | +| `result` | [string](../../concepts/fundamentals/05_blocks.md) | The latest state root | diff --git a/documentation/references/apis/04_get_block.md b/documentation/references/apis/04_get_block.md index 57f296c1..44345494 100644 --- a/documentation/references/apis/04_get_block.md +++ b/documentation/references/apis/04_get_block.md @@ -21,5 +21,5 @@ Returns the block for the given block height or block hash. | Parameter | Type | Description | |:---------:|:-------------------------------------:|:-------------------:| -| `result` | [object](../../concepts/beginner/05_blocks.md) | The requested block | +| `result` | [object](../../concepts/fundamentals/05_blocks.md) | The requested block | diff --git a/documentation/references/apis/04_get_blocks.md b/documentation/references/apis/04_get_blocks.md index d5fd6f7f..c7c55699 100644 --- a/documentation/references/apis/04_get_blocks.md +++ b/documentation/references/apis/04_get_blocks.md @@ -22,5 +22,5 @@ Returns the blocks for the given block range. | Parameter | Type | Description | |:---------:|:------------------------------------:|:--------------------:| -| `result` | [array](../../concepts/beginner/05_blocks.md) | The requested blocks | +| `result` | [array](../../concepts/fundamentals/05_blocks.md) | The requested blocks | diff --git a/documentation/references/apis/05_get_block_transactions.md b/documentation/references/apis/05_get_block_transactions.md index e3354b55..99f84659 100644 --- a/documentation/references/apis/05_get_block_transactions.md +++ b/documentation/references/apis/05_get_block_transactions.md @@ -20,4 +20,4 @@ Returns the transactions for the given block height. | Parameter | Type | Description | |:---------:|:------------------------------------------:|:--------------------------------------:| -| `result` | [array](../../concepts/beginner/03_transactions.md) | The array of transactions in the block | +| `result` | [array](../../concepts/fundamentals/03_transactions.md) | The array of transactions in the block | diff --git a/documentation/references/apis/06_get_transaction.md b/documentation/references/apis/06_get_transaction.md index 5280077e..359d6879 100644 --- a/documentation/references/apis/06_get_transaction.md +++ b/documentation/references/apis/06_get_transaction.md @@ -20,4 +20,4 @@ Returns the transaction for the given transaction ID. | Parameter | Type | Description | |:---------:|:-------------------------------------------:|:-------------------------:| -| `result` | [object](../../concepts/beginner/03_transactions.md) | The requested transaction | \ No newline at end of file +| `result` | [object](../../concepts/fundamentals/03_transactions.md) | The requested transaction | \ No newline at end of file diff --git a/documentation/references/apis/07_get_memory_pool_transactions.md b/documentation/references/apis/07_get_memory_pool_transactions.md index 8c195aee..998f4ba3 100644 --- a/documentation/references/apis/07_get_memory_pool_transactions.md +++ b/documentation/references/apis/07_get_memory_pool_transactions.md @@ -18,4 +18,4 @@ None | Parameter | Type | Description | |:---------:|:------------------------------------------:|:-------------------------:| -| `result` | [array](../../concepts/beginner/03_transactions.md) | The array of transactions | \ No newline at end of file +| `result` | [array](../../concepts/fundamentals/03_transactions.md) | The array of transactions | \ No newline at end of file diff --git a/documentation/references/apis/08_get_program.md b/documentation/references/apis/08_get_program.md index 0e0c74fc..9a6daa98 100644 --- a/documentation/references/apis/08_get_program.md +++ b/documentation/references/apis/08_get_program.md @@ -20,4 +20,4 @@ Returns the program for the given program ID. | Parameter | Type | Description | |:---------:|:---------------------------------------:|:---------------------:| -| `result` | [object](../../concepts/beginner/01_programs.md) | The requested program | \ No newline at end of file +| `result` | [object](../../concepts/fundamentals/01_programs.md) | The requested program | \ No newline at end of file diff --git a/documentation/references/apis/10_get_committee.md b/documentation/references/apis/10_get_committee.md index 184fd453..017d7098 100644 --- a/documentation/references/apis/10_get_committee.md +++ b/documentation/references/apis/10_get_committee.md @@ -18,4 +18,4 @@ None | Parameter | Type | Description | |:---------:|:--------------------------------------:|:----------------------------:| -| `result` | [array](../../concepts/beginner/00_accounts.md) | The latest committee members | \ No newline at end of file +| `result` | [array](../../concepts/fundamentals/00_accounts.md) | The latest committee members | \ No newline at end of file diff --git a/documentation/references/apis/11_get_mapping_names.md b/documentation/references/apis/11_get_mapping_names.md index cff851ea..9e1129c8 100644 --- a/documentation/references/apis/11_get_mapping_names.md +++ b/documentation/references/apis/11_get_mapping_names.md @@ -20,4 +20,4 @@ Returns the names of the mappings in a program for the given program ID. | Parameter | Type | Description | |:---------:|:---------------------------------------:|:---------------------------:| -| `array` | [object](../../concepts/beginner/01_programs.md) | The requested mapping names | \ No newline at end of file +| `array` | [object](../../concepts/fundamentals/01_programs.md) | The requested mapping names | \ No newline at end of file diff --git a/documentation/references/apis/12_get_mapping_value.md b/documentation/references/apis/12_get_mapping_value.md index 26bbcb0c..330f24df 100644 --- a/documentation/references/apis/12_get_mapping_value.md +++ b/documentation/references/apis/12_get_mapping_value.md @@ -23,4 +23,4 @@ Returns the value in a key-value mapping corresponding to the supplied mappingKe | Parameter | Type | Description | |:---------:|:---------------------------------------:|:----------------------------------------------:| -| `result` | [object](../../concepts/beginner/01_programs.md) | The value of the key-value pair in the mapping | +| `result` | [object](../../concepts/fundamentals/01_programs.md) | The value of the key-value pair in the mapping | diff --git a/leo b/leo index 61c71e6e..72a9acc8 160000 --- a/leo +++ b/leo @@ -1 +1 @@ -Subproject commit 61c71e6e7b7a109a29c571fbe1db27191ff39719 +Subproject commit 72a9acc89afe2337d878f9d3da624071a6e84585 diff --git a/sdk b/sdk index 8f729e12..25a333db 160000 --- a/sdk +++ b/sdk @@ -1 +1 @@ -Subproject commit 8f729e12477f45aef307fb737941d1c66c6ef493 +Subproject commit 25a333dba032a7598068bd6e56710084f6e0e55c diff --git a/snarkOS b/snarkOS index 3a445617..d2699881 160000 --- a/snarkOS +++ b/snarkOS @@ -1 +1 @@ -Subproject commit 3a445617fcdbc5f5aaf10710506cb29e90fc5210 +Subproject commit d26998812799de249fbd8f1a3e461fe648ead407 diff --git a/snarkVM b/snarkVM index d2472c3e..7c4a910f 160000 --- a/snarkVM +++ b/snarkVM @@ -1 +1 @@ -Subproject commit d2472c3e4422100aa77d490882281e6af9f76ba3 +Subproject commit 7c4a910f70a1f8c953b95bfc3aaa2bc3131d5b7d