diff --git a/docs/docs/aztec/concepts/pxe/index.md b/docs/docs/aztec/concepts/pxe/index.md index 85fd06b283cb..151ceb897871 100644 --- a/docs/docs/aztec/concepts/pxe/index.md +++ b/docs/docs/aztec/concepts/pxe/index.md @@ -3,7 +3,7 @@ title: Private Execution Environment (PXE) sidebar_position: 6 --- -The Private Execution Environment (or PXE, pronounced 'pixie') is a client-side library for the execution of private operations. It is a TypeScript library and can be run within Node, such as when you run the sandbox, within the browser, or any other environment in which TypeScript can run. For example, in future it could be run inside wallet software. +The Private Execution Environment (or PXE, pronounced 'pixie') is a client-side library for the execution of private operations. It is a TypeScript library and can be run within Node, such as when you run the sandbox. In the future it could be run inside wallet software or a browser. The PXE generates proofs of private function execution, and sends these proofs along with public function requests to the sequencer. Private inputs never leave the client-side PXE. diff --git a/docs/docs/aztec/glossary/index.md b/docs/docs/aztec/glossary/index.md index 52efbc04af03..e041e18bc55a 100644 --- a/docs/docs/aztec/glossary/index.md +++ b/docs/docs/aztec/glossary/index.md @@ -2,11 +2,15 @@ title: Glossary --- -### Smart Contracts +### `aztec-nargo` -Programs that run on the Aztec network are called smart contracts, similar to [programs](https://ethereum.org/en/developers/docs/smart-contracts/) that run on Ethereum. +The command line tool used to compile Aztec contracts. It gets its name from the Noir compiler, `nargo`. `aztec-nargo` is really just a specific version of `nargo`. You can read more about `nargo` [here](#nargo). -However, these will be written in the [Noir](https://noir-lang.org/index.html) programming language, and may optionally include [private state and private functions](https://docs.aztec.network/aztec/how-it-works/private-smart-contracts). +### Aztec.nr + +A [Noir](https://noir-lang.org) framework for writing smart contracts on Aztec. + +Read more and review the source code [here](https://aztec.nr). ### Barretenberg @@ -14,6 +18,28 @@ Aztec's cryptography back-end. Refer to the graphic at the top of [this page](ht Barretenberg's source code can be found [here](https://github.com/AztecProtocol/barretenberg). +### `nargo` + +With `nargo`, you can start new projects, compile, execute, prove, verify, test, generate solidity contracts, and do pretty much all that is available in Noir. + +You can find more information in the nargo installation docs [here](https://noir-lang.org/docs/getting_started/installation/) and the nargo command reference [here](https://noir-lang.org/docs/reference/nargo_commands). + +### Noir + +Noir is a Domain Specific Language for SNARK proving systems. It is used for writing smart contracts in Aztec because private functions on Aztec are implemented as SNARKs to support privacy-preserving operations. + +### Provers + +Aztec will be launched with a fully permissionless proving network that anyone can participate in. + +How this works will be discussed via a future RFP process on Discourse, similarly to the Sequencer RFP. + +### Private Execution Environment + +The Private eXecution Environment (PXE) is a client-side library for the execution of private operations. The PXE generates proofs of private function execution, and sends these proofs along with public function requests to the sequencer. Private inputs never leave the client-side PXE. + +Read more [here](../concepts/pxe/index.md). + ### Sequencer Aztec will be launched with a fully permissionless sequencer network that anyone can participate in. @@ -34,11 +60,11 @@ Sequencers are generally responsible for: Previously in [Aztec Connect](https://medium.com/aztec-protocol/sunsetting-aztec-connect-a786edce5cae) there was a single sequencer, and you can find the Typescript reference implementation called Falafel [here](https://github.com/AztecProtocol/aztec-connect/tree/master/yarn-project/falafel). -### Provers +### Smart Contracts -Aztec will be launched with a fully permissionless proving network that anyone can participate in. +Programs that run on the Aztec network are called smart contracts, similar to [programs](https://ethereum.org/en/developers/docs/smart-contracts/) that run on Ethereum. -How this works will be discussed via a future RFP process on Discourse, similarly to the Sequencer RFP. +However, these will be written in the [Noir](https://noir-lang.org/index.html) programming language, and may optionally include [private state and private functions](https://docs.aztec.network/aztec/how-it-works/private-smart-contracts). ### Proving Key diff --git a/docs/docs/reference/sandbox_reference/index.md b/docs/docs/reference/sandbox_reference/index.md index 88c4949bf432..1697ca3d4151 100644 --- a/docs/docs/reference/sandbox_reference/index.md +++ b/docs/docs/reference/sandbox_reference/index.md @@ -35,4 +35,4 @@ The current sandbox does not generate or verify proofs, but provides a working e ## Command line tools -Aztec-nargo and aztec-builder are command-line tool allowing you to compile smart contracts. See the [compiling contracts](../../guides/smart_contracts/how_to_compile_contract.md) page for more information. +Aztec-nargo and aztec-builder are command-line tool allowing you to compile smart contracts. See the [compiling contracts](../../guides/smart_contracts/how_to_compile_contract.md) page for more information. \ No newline at end of file diff --git a/docs/docs/tutorials/contract_tutorials/crowdfunding_contract.md b/docs/docs/tutorials/contract_tutorials/crowdfunding_contract.md index 0280a5a214dd..11735715ce33 100644 --- a/docs/docs/tutorials/contract_tutorials/crowdfunding_contract.md +++ b/docs/docs/tutorials/contract_tutorials/crowdfunding_contract.md @@ -1,11 +1,10 @@ --- - title: "Crowdfunding contract" sidebar_position: 2 tags: [developers, tutorial, example] --- -# Build a donations contract +# Write a donations contract In this tutorial we'll create two contracts related to crowdfunding: