README.md

Clober V2

Core Contract of Clober DEX V2

Table of Contents

• Clober V2
  • Table of Contents
  • Deployments
  • Install
  • Usage
    • Tests
    • Linting
    • Library
  • Licensing

Deployments

All deployments can be found in the deployments directory.

Install

Prerequisites

• We use Forge Foundry for test. Follow the guide to install Foundry.

Installing From Source

git clone https://github.com/clober-dex/v2-core && cd v2-core
npm install

Usage

Tests

npm run test

Linting

To run lint checks:

npm run prettier:ts
npm run lint:sol

To run lint fixes:

npm run prettier:fix:ts
npm run lint:fix:sol

Library

To utilize the contracts, you can install the code in your repo with forge:

forge install https://github.com/clober-dex/v2-core

Licensing

• The primary license for Clober Core V2 is the Time-delayed Open Source Software Licence, see License file.
• Interfaces are licensed under MIT (as indicated in their SPDX headers).
• Some libraries have a GPL license.