@aztec/note-access v1.1.4
Warning :rotating_light:
This is a proof of concept. The trusted setup was generated by our team internally. We will be releasing more information about the production trusted setup generation in the near future. Use at own risk.
Documentation :books:
There are two key sources of documentation:
- Protocol specification: https://aztec-protocol.gitbook.io/aztec-documentation/
aztec.jsclient side proof construction API: https://aztecprotocol.github.io/AZTEC/
Packages :package:
AZTEC is maintained as a monorepo with multiple sub packages. Please find a comprehensive list below.
JavaScript Packages
| Package | Version | Description |
|---|---|---|
aztec.js | An aggregate package combining many smaller utility packages for interacting with the AZTEC Protocol | |
@aztec/contract-artifacts | AZTEC smart contract compiled artifacts | |
@aztec/contract-addresses | A tiny utility library for getting known deployed contract addresses for a particular network | |
@aztec/dev-utils | Dev utils to be shared across AZTEC projects and packages |
Solidity Packages
| Package | Version | Description |
|---|---|---|
@aztec/protocol | AZTEC solidity smart contracts & tests |
Private Packages
| Package | Description |
|---|---|
@aztec/monorepo-scripts | Scripts for managing the monorepo |
Usage :hammer_and_pick:
To create AZTEC notes and construct zero-knowledge proofs:
$ yarn add aztec.jsOther goodies:
$ yarn add @aztec/contract-artifacts
$ yarn add @aztec/contract-addresses
$ yarn add @aztec/dev-utilsTo see a demo, head to this tutorial.
For more information, check out our documentation.
Contributing :raising_hand_woman:
Requirements
- node >=8.3
- yarn >=1.15.2
- solidity >=0.5.0 <0.6.0
Pre Requisites
Make sure you are using Yarn >= 1.15.2. To install using brew:
brew install yarnThen install dependencies:
yarn installBuild
To build all packages:
$ yarn buildTo build a specific package:
$ PKG=aztec.js yarn buildWatch
To re-build all packages on change:
$ yarn watchClean
To clean all packages:
$ yarn cleanTo clean a specific package:
$ PKG=aztec.js yarn cleanLint
To lint all packages:
$ yarn lintTo lint a specific package:
$ PKG=aztec.js yarn lintTest
To run all tests:
$ yarn testTo run tests in a specific package:
$ PKG=aztec.js yarn testFAQ :question:
What is the AZTEC Protocol?
The protocol enables transactions of value, where the values of the transaction are encrypted. The AZTEC protocol smart contract validator, AZTEC.sol, validates a unique zero-knowledge proof that determines the legitimacy of a transaction via a combination of homomorphic encryption and range proofs.
What is encrypted 'value'?
Instead of balances, the protocol uses AZTEC notes. A note encrypts a number that represents a value (for example a number of ERC-20 tokens). Each note has an owner, defined via an Ethereum address. In order to spend a note the owner must provide a valid ECDSA signature attesting to this.
What does this enable?
Confidential representations of ERC20-tokens
The AZTEC protocol can enable confidential transactions for any generic digital asset on Ethereum, including existing assets. For our proof of concept implementation of the AZTEC protocol, we attached an AZTEC token to MakerDAO's DAI token. This smart contract can be used to convert DAI from its public ERC-20 form into a confidential AZTEC note form.
Fully confidential digital assets
The AZTEC protocol can be utilized as a stand-alone confidential token, with value transfers described entirely through AZTEC join-split transactions
How much gas do these transactions cost?
The gas costs scale with the number of input and output notes in a join-split transaction. For a fully confidential transfer, with 2 input notes and 2 output notes, the gas cost is approximately 900,000 gas. Planned EIP improvements will reduce the cost of these transactions dramatically, to approximately 200,000 - 300,000 gas.
Where can I see this in action?
The AZTEC protocol is live today on the Ethereum main-net. Our proof of concept contract converts DAI into AZTEC note form and is live on the Ethereum main-net. Here is an example AZTEC join-split transaction.
Range proofs you say? How does that work?
Read the AZTEC paper here. The unique AZTEC commitment function enables the efficient construction and verification of range proofs. The protocol requires a trusted setup protocol, that generates a dataset that is required to construct AZTEC zero-knowledge proofs
The Trusted Setup
Our proof of concept uses a trusted setup generated by our team internally. Whilst we would like to think you can trust us implicitly, we have developed a method of performing the trusted setup via multiparty computation. Each participant generates a piece of toxic waste that must be destroyed. Only one participant must destroy their toxic waste for the protocol to be secure and the trusted setup process can scale indefinitely. We will be releasing our full specification for the trusted setup protocol shortly.
Are AZTEC transactions anonymous as well as confidential?
The AZTEC protocol supports a stealth address protocol that can be used to obfuscate the link between a note 'owner' and any on-chain identity.
This sounds interesting! How can I get involved?
Anybody wishing to become early members of the AZTEC network please get in touch at hello@aztecprotocol.com