# @aztec/protocol

> Main AZTEC smart contract repository

Latest version **1.7.1** (published 2020-07-23) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @aztec/protocol
pnpm add @aztec/protocol
yarn add @aztec/protocol
bun add @aztec/protocol
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.7.1 |
| Published | 2020-07-23 |
| First published | 2019-01-31 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.3 |
| Dependencies | 7 |
| Unpacked size | 563.5 KB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 630 |
| Author | AZTEC |
| Maintainers | arnauds, charlielye, jaosef, leilawang, tom_waite, zac-williamson |
| Keywords | aztec, blockchain, confidentiality, cryptography, ethereum, privacy, protocol |

## Links

- npm: https://www.npmjs.com/package/@aztec/protocol
- Repository: https://github.com/AztecProtocol/AZTEC
- Homepage: https://github.com/AztecProtocol/AZTEC/tree/master/packages/protocol#readme
- Issues: https://github.com/AztecProtocol/AZTEC/issues
- npm.io page: https://npm.io/package/@aztec/protocol

## Dependencies (7)

- [axios](https://npm.io/package/axios.md) ^0.19.0
- [@openzeppelin/network](https://npm.io/package/@openzeppelin/network.md) ^0.2.10
- [openzeppelin-solidity](https://npm.io/package/openzeppelin-solidity.md) ^2.4.0
- [@openzeppelin/upgrades](https://npm.io/package/@openzeppelin/upgrades.md) ^2.6.0
- [@openzeppelin/gsn-helpers](https://npm.io/package/@openzeppelin/gsn-helpers.md) ^0.2.1
- [@openzeppelin/gsn-provider](https://npm.io/package/@openzeppelin/gsn-provider.md) ^0.1.9
- [@openzeppelin/contracts-ethereum-package](https://npm.io/package/@openzeppelin/contracts-ethereum-package.md) ^2.4.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.7.1 (latest) — 2020-07-23
- 0.4.3-beta.2 (beta) — 2019-03-28
- 1.7.0 — 2020-03-20
- 1.6.0 — 2020-02-27
- 1.5.0 — 2020-02-13
- 1.4.0 — 2020-01-31
- 1.3.0 — 2020-01-31
- 1.2.1 — 2020-01-30
- 1.2.0 — 2020-01-30
- 1.0.4 — 2020-01-30
- 1.0.3 — 2020-01-30
- 1.0.2 — 2020-01-30
- 1.1.0 — 2020-01-30
- 0.12.1 — 2019-11-07
- 0.12.0 — 2019-11-07
- … 29 more at https://npm.io/package/@aztec/protocol/versions

## README

## Protocol

This package contains the core smart contracts of the AZTEC Protocol. The contracts are written in solidity and yul.

## Pre Requisites

### Truffle

```bash
$ yarn global add truffle
$ yarn global add ganache-cli
```

## Usage

To venture out with the contracts, just compile and deploy them with truffle:

```bash
truffle compile --all
truffle migrate --network development
```

Make sure to have a running ganache instance in the background.

## Contributing

We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../.github/CONTRIBUTING.md) before getting started.

### Install Modules

```bash
$ yarn install
```

### Clean

```bash
$ yarn clean
```

### Lint

```bash
$ yarn lint
```

### Test

```bash
$ yarn test
```

---
_Source: https://npm.io/package/@aztec/protocol · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
