# zircon-protocol

> Core Contracts

Latest version **1.0.3-alpha.1** (published 2022-04-12) · 0 weekly downloads

## Install

```sh
npm install zircon-protocol
pnpm add zircon-protocol
yarn add zircon-protocol
bun add zircon-protocol
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3-alpha.1 |
| Published | 2022-04-12 |
| First published | 2022-02-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 6 |
| Unpacked size | 56.3 MB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | reshy, vittoridavid |

## Links

- npm: https://www.npmjs.com/package/zircon-protocol
- Repository: https://github.com/Zircon-Finance/zircon-protocol
- Homepage: https://zircon.finance
- Issues: https://github.com/Zircon-Finance/zircon-protocol/issues
- npm.io page: https://npm.io/package/zircon-protocol

## Dependencies (6)

- [dotenv](https://npm.io/package/dotenv.md) ^10.0.0
- [@uniswap/lib](https://npm.io/package/@uniswap/lib.md) ^4.0.1-alpha
- [hardhat-watcher](https://npm.io/package/hardhat-watcher.md) ^2.1.1
- [@uniswap/v2-core](https://npm.io/package/@uniswap/v2-core.md) ^1.0.1
- [@uniswap/v2-periphery](https://npm.io/package/@uniswap/v2-periphery.md) ^1.1.0-beta.0
- [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) 2.5.0

## Recent versions

- 1.0.3-alpha.1 (latest) — 2022-04-12
- 1.0.3-alpha.0 — 2022-04-07
- 1.0.2 — 2022-03-26
- 1.0.1 — 2022-03-21
- 1.0.0 — 2022-02-28

## README

![](https://img.shields.io/badge/Zircon-blueviolet)

# Zircon Protocol

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Actions Status](https://github.com/Uniswap/uniswap-sdk/workflows/CI/badge.svg)](https://github.com/Uniswap/uniswap-sdk)
[![npm version](https://img.shields.io/npm/v/@uniswap/sdk/latest.svg)](https://www.npmjs.com/package/@uniswap/sdk/v/latest)
[![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@uniswap/sdk/latest.svg)](https://bundlephobia.com/result?p=@uniswap/sdk@latest)

In-depth documentation on this SDK is available at [uniswap.org](https://uniswap.org/docs/v2/SDK/getting-started/), while basic documentation for Pylon at [zircon.finance](https://docs.zircon.finance)


## Links
  - [Website](https://www.zircon.finance/)
  - [Beta](https://beta.zircon.finance/)
  - [Docs](https://docs.zircon.finance/)
 
  Socials:
  - [Discord](https://discord.gg/wbqNAqvvTg)
  - [Twitter](https://twitter.com/Zircon_Finance)
  - [Email](mailto:hello@zircon.finance)
  - [Reddit](https://www.reddit.com/r/zirconfinance)

## Pylon Enhancements

The protocol includes the contracts handling Pylon and its new single-sided liquidity features.

Our architecture works on top of Uniswap v2, enabling the creation of two Pylons per pair, which handle the single-sided liquidity provision. Each Pylon holds both UniV2 LP tokens of its associated pool and a percentage of reserves of both tokens in the pair. Pylon extends on the basic Uniswap Pair ERC-20 token with the Zircon Pool Token, which is an ERC-20 representation for the Float and Anchor Shares.

Our Pylon Router handles all the communication between the user and the Pylon. 

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone git@github.com:Zircon-Finance/zircon-protocol.git
```

Move into the zircon-protocol working directory

```sh
cd zircon-sdk/
```

Install dependencies

```sh
yarn compile
```

Run tests

```sh
yarn test
```

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