Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

Aztec Standards is a comprehensive collection of reusable, standardized contracts for the Aztec Network. It provides a robust foundation of token primitives and utilities that support both private and public operations, empowering developers to build innovative privacy-preserving applications with ease.

## Security Review Status

This repository is developed with security best practices in mind, including testing and review as part of ongoing development. The contracts and supporting code have not yet undergone a formal third-party security audit. Treat this package as unaudited code: review it carefully, test it for your integration, and use appropriate safeguards before relying on it in production.

## Development

**Prerequisite**: Start an Aztec local network in a separate terminal:
Expand All @@ -18,6 +22,7 @@ aztec start --local-network
Set `NODE_URL` to override the default (e.g. `http://localhost:9000`).

## Table of Contents
- [Security Review Status](#security-review-status)
- [Development](#development)
- [Dripper Contract](#dripper-contract)
- [Token Contract](#token-contract)
Expand Down Expand Up @@ -66,4 +71,4 @@ To see examples of Logic contract implementations, such as a linear vesting cont

## Future Contracts

Additional standardized contracts (e.g., staking, governance, pools) will be added under this repository, with descriptions and function lists.
Additional standardized contracts (e.g., staking, governance, pools) will be added under this repository, with descriptions and function lists.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "@aztec-foundation/aztec-standards",
"version": "5.1.0",
"description": "Reusable Aztec Network contract standards and utilities for privacy-preserving applications. See README for current security review status.",
"repository": {
"type": "git",
"url": "git+https://github.com/AztecProtocol/aztec-standards.git"
Expand Down
Loading