# @zk-kit/artifacts

> Utilities for downloading snark artifacts

Latest version **2.0.1** (published 2024-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zk-kit/artifacts
pnpm add @zk-kit/artifacts
yarn add @zk-kit/artifacts
bun add @zk-kit/artifacts
```

Provides the command `snarkli`.

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2024-08-13 |
| First published | 2024-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 47.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Maintainers | sripwoud, njofce, akinovak, cedoor |
| Keywords | snark, artifacts, circom, zk |

## Links

- npm: https://www.npmjs.com/package/@zk-kit/artifacts
- Repository: https://github.com/privacy-scaling-explorations/snark-artifacts
- Homepage: https://github.com/privacy-scaling-explorations/snark-artifacts/tree/main/packages/artifacts
- Issues: https://github.com/privacy-scaling-explorations/snark-artifacts/issues
- npm.io page: https://npm.io/package/@zk-kit/artifacts

## Dependencies (6)

- [ora](https://npm.io/package/ora.md) ^5.4.1
- [snarkjs](https://npm.io/package/snarkjs.md) ^0.7.4
- [circomkit](https://npm.io/package/circomkit.md) ^0.2.1
- [@inquirer/input](https://npm.io/package/@inquirer/input.md) ^2.1.8
- [@inquirer/select](https://npm.io/package/@inquirer/select.md) ^2.3.4
- [@commander-js/extra-typings](https://npm.io/package/@commander-js/extra-typings.md) ^12.1.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2024-08-13
- 2.0.0 — 2024-08-07
- 1.9.0 — 2024-06-27
- 1.8.0 — 2024-06-22
- 1.7.0 — 2024-06-21
- 1.6.0 — 2024-06-03
- 1.5.1 — 2024-05-31
- 1.5.0 — 2024-05-28
- 1.4.1 — 2024-05-27
- 1.4.0 — 2024-05-27
- 1.3.2 — 2024-05-20
- 1.3.1 — 2024-05-19
- 1.3.0 — 2024-05-19
- 1.1.0 — 2024-05-14
- 1.0.0 — 2024-05-13

## README

<p align="center">
    <h1 align="center">
        @zk-kit/artifacts
    </h1>
</p>
<p align="center">
    <a href="https://npmjs.org/package/@zk-kit/artifacts">
        <img src="https://img.shields.io/npm/v/@zk-kit/artifacts.svg?style=flat-square" alt="NPM version" />
    </a>
    <a href="https://npmjs.org/package/@zk-kit/artifacts">
        <img src="https://img.shields.io/npm/dm/@zk-kit/artifacts.svg?style=flat-square" alt="Downloads" />
    </a>
</p>

## Downloading artifacts

`@zk-kit/artifacts` provides a set of functions to automatically download artifacts from the snark artifacts registry hosted by [PSE](https://pse.dev) at [snark-artifacts.pse.dev](https://snark-artifacts.pse.dev). For example:

```ts
import { maybeGetSnarkArtifacts, Project } from '@zk-kit/artifacts'

// It will return the artifacts' paths.
const { wasm, zkey } = await maybeGetSnarkArtifacts(Project.POSEIDON, {
  parameters: [2],
  version: '1.0.0',
})

console.log(wasm) // "/tmp/@zk-kit/poseidon-artifacts@1.0.0/poseidon-2.wasm"
console.log(zkey) // "/tmp/@zk-kit/poseidon-artifacts@1.0.0/poseidon-2.zkey"

// Paths on browsers will be the `unpkg` URLs directly.
// e.g. https://unpkg.com/@zk-kit/poseidon-artifacts@1.0.0/poseidon-2.zkey
```

## CLI

Or you can install our `snarkli` CLI to download artifacts, list available packages or generate artifacts (`.zkey`, `.wasm`) from `.circom` source files.

```commandline
pnpm add -g @zk-kit/artifacts
snarkli
```

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