Core Contract of Clober DEX

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

To install dependencies and compile contracts:

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

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

npm run test:unit:forge

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

To run coverage profile:

npm run coverage:local
open coverage/index.html

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

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

• 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).