KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

citadel-contracts

★ 32 Open GitHub ↗

Citadel DAO Core Contracts

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Citadel
![](https://raw.githubusercontent.com/Citadel-DAO/citadel-contracts/main/docs/images/citadel-knights.png)
> Assemby of the Knights

The high-level concepts and progress updates can be found on [Medium](https://thecitadeldao.medium.com/).

An [informal video](https://drive.google.com/file/d/1hCzQrgZEsbd0t2mtuaXm7Cp3YS-ZIlw3/view?usp=sharing) offering a summary of the smart contracts.

# Getting Started

## Prerequisites

- [Foundry](https://github.com/gakonst/foundry)
- [Node.js & NPM](https://nodejs.org/en/)
- [NPX](https://www.npmjs.com/package/npx)

## Installation

Install and update submodules:

```console
git submodule init
git submodule update
```

## Installation

Install hardhat dependencies:

```console
npm install
```

## Compilation

```
forge build
```

## Tests

Because the tests interact with mainnet contracts, tests must be run in mainnet fork mode.

```
forge test --fork-url <mainnet-rpc-url>
```

> ⚠️ Some tests are currently failing, they are under active development

## Hardhat deploy

Hardhat Ganace is more reliable than ganache itself for UI testing so we provide an integration with hardhat as well.
This will be run the deploy script on default network, but don't be shy to use other hardhat options for it

```
npx hardhat run scripts/deploy-local.js --network localhost
```

For deploying using mock cvx and wbtc use this script

```
npx hardhat run scripts/deploy-mock.js --network YOUR_SELECTED_NETWORK
```

For minting mock wbtc or cvx use this tasks

```
npx hardhat  --network YOUR_SELECTED_NETWORK  mint-wbtc --address YOUR_SELECTED_ADDRESS --amount YOUR_SELECTED_AMOUNT
npx hardhat  --network YOUR_SELECTED_NETWORK  mint-cvx --address YOUR_SELECTED_ADDRESS --amount YOUR_SELECTED_AMOUNT
```

# System Overview
An informal video offering a [summary of the system](https://drive.google.com/file/d/1hCzQrgZEsbd0t2mtuaXm7Cp3YS-ZIlw3/view?usp=sharing).

# Contract / Subsystem Overviews
- [Access Control](./docs/access-control.md)
- [Citadel Token](./docs/citadel-token.md)
- [Staked Citadel](./docs/staked-citadel.md)
- [Locked Citadel](./docs/locked-citadel.md)
- [Emissions and Distribution](./docs/emissions.md)
- [Knighting Round](./docs/knighting-round.md)
- [Oracles](./docs/oracles.md)
- [Other](./docs/explainer.md)

# Codearena: Audit Scope & Assumptions
- Assume all allocated role permissions are correct in the setup of the system.
    - e.g. holders of CONTRACT_GOVERNANCE_ROLE won't rug or set malicious permissions for other roles.
    - However, if roles can be set in an unintended manner, this is a very valid finding,

See [BaseFixture.sol](./src/test/BaseFixture.sol) for how the system components are wired together in practice.

## What's in scope?
* All (non-test) contracts in this repo.
* The [modified convex locker](https://github.com/Citadel-DAO/staked-citadel-locker/blob/main/src/StakedCitadelLocker.sol) from our staked-citadel-locker repo.
* The [MedianOracle](https://github.com/ampleforth/market-oracle/blob/master/contracts/MedianOracle.sol) from ampleforth.

citadel-contracts

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README