# circomlib

> Basic circuits library for Circom

Latest version **2.0.5** (published 2022-06-17) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install circomlib
pnpm add circomlib
yarn add circomlib
bun add circomlib
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.5 |
| Published | 2022-06-17 |
| First published | 2018-12-20 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 750 |
| Author | 0Kims |
| Maintainers | jbaylina |
| Keywords | pedersen, hash, ethereum, circuit, circom, zksnark |

## Links

- npm: https://www.npmjs.com/package/circomlib
- Repository: https://github.com/iden3/circomlib
- Homepage: https://github.com/iden3/circomlib#readme
- Issues: https://github.com/iden3/circomlib/issues
- npm.io page: https://npm.io/package/circomlib

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 2.0.5 (latest) — 2022-06-17
- 2.0.4 — 2022-06-15
- 2.0.3 — 2022-02-23
- 2.0.2 — 2021-10-30
- 2.0.1 — 2021-10-23
- 2.0.0 — 2021-10-11
- 0.5.5 — 2021-10-04
- 0.5.4 — 2021-09-24
- 0.5.3 — 2021-07-12
- 0.5.2 — 2021-04-03
- 0.5.1 — 2021-03-11
- 0.5.0 — 2021-03-08
- 0.4.1 — 2020-12-26
- 0.4.0 — 2020-12-26
- 0.3.0 — 2020-11-26
- … 27 more at https://npm.io/package/circomlib/versions

## README

# CircomLib

## Description

- This repository contains a library of circuit templates. 
- All files are copyrighted under 2018 0KIMS association and part of the free software [circom](https://github.com/iden3/circom) (Zero Knowledge Circuit Compiler). 
- You can read more about the circom language in [the circom documentation webpage](https://docs.circom.io/).

## Organisation

This respository contains 5 folders:
- `circuits`: it contains the implementation of different cryptographic primitives in circom language.
- `calcpedersenbases`: set of functions in JavaScript used to find a set of points in [Baby Jubjub](https://github.com/barryWhiteHat/baby_jubjub) elliptic curve that serve as basis for the [Pedersen Hash](https://github.com/zcash/zcash/issues/2234).
- `doc`: it contains some circuit schemes in ASCII (must be opened with Monodraw, an ASCII art editor for Mac).
- `src`: it contains similar implementation of circuits in JavaScript.
- `test`: tests.

A description of the specific circuit templates for the `circuit` folder will be soon updated.

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