Clober

Core Contract of Clober DEX

Table of Contents

• Clober
  • Table of Contents
  • Deployments
  • Install
  • Usage
    • Unit Tests
    • Integration Tests
    • Coverage
    • Linting
  • Audits
  • Licensing

Deployments

v1.1.0 Deployments On EVM Chain

	MarketFactory	MarketRouter	OrderCanceler
PolygonZkEVM	0x24aC0938C010Fb520F1068e96d78E0458855111D	0x4C95C9a2a0F5DB89401721E4a0BF279c4E0144C5	0xFc03c0bad134A0c0151db9358AD697c5dAF611Ee
Polygon	0x24aC0938C010Fb520F1068e96d78E0458855111D	0xB4be941716d4d27147D5A4d82801897877CA5906	0xFc03c0bad134A0c0151db9358AD697c5dAF611Ee
Arbitrum	0x24aC0938C010Fb520F1068e96d78E0458855111D	0xB4be941716d4d27147D5A4d82801897877CA5906	0xFc03c0bad134A0c0151db9358AD697c5dAF611Ee

v1.0.0 Deployments On EVM Chain

	MarketFactory	MarketRouter	OrderCanceler
Ethereum	0x93A43391978BFC0bc708d5f55b0Abe7A9ede1B91	0x6d928455050b3b71490fe3B73DD84daD094299c4	0x99228D1823baFa822dAB2B2f0a02922082f25E9E
Polygon(Deprecated)	0x93A43391978BFC0bc708d5f55b0Abe7A9ede1B91	0x6d928455050b3b71490fe3B73DD84daD094299c4	0x99228D1823baFa822dAB2B2f0a02922082f25E9E
Arbitrum(Deprecated)	0x93A43391978BFC0bc708d5f55b0Abe7A9ede1B91	0x6d928455050b3b71490fe3B73DD84daD094299c4	0x99228D1823baFa822dAB2B2f0a02922082f25E9E

Install

To install dependencies and compile contracts:

Prerequisites

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

Installing From Source

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

Usage

Unit tests

npm run test:unit:forge

Integration tests

npm run test:limit:forge  # Run Limit Order Integration Tests
npm run test:market:forge # Run Market Order Integration Tests
npm run test:claim:forge  # Run Claim Order Integration Tests
npm run test:cancel:forge # Run Cancel Order Integration Tests

Coverage

To run coverage profile:

npm run coverage:local
open coverage/index.html

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

Audits

Audited by Spearbit from January to February 2023. All security risks are fixed. Full report is available here.

Licensing

• The primary license for Clober Core is the Time-delayed Open Source Software Licence, see License file.
• All files in contracts/interfaces may also be licensed under GPL-2.0-or-later (as indicated in their SPDX headers), see LICENSE_GPL.
• contracts/utils/ReentrancyGuard.sol file is licensed under AGPL-3.0-only (as indicated in their SPDX headers), see LICENSE_APGL.
• contracts/utils/BoringERC20.sol file is licensed under MIT (as indicated in their SPDX headers).