Skip to content

Latest commit

 

History

History
129 lines (79 loc) · 3.94 KB

README.md

File metadata and controls

129 lines (79 loc) · 3.94 KB

Citadel Finance

Citadel Finance is a decentralized finance (DeFi) protocol and fork of Synthereum by Jarvis Protocol. Designed for creating and managing synthetic assets, Citadel Finance leverages on-chain liquidity to provide users with accessible, stable, and tradable synthetic tokens on the Binance Smart Chain (BSC).

Table of Contents

Overview

Citadel Finance aims to offer a stable, secure, and transparent environment for issuing synthetic assets. Built on the Binance Smart Chain, it allows users to interact with tokenized assets that track the price of real-world assets without needing centralized exchanges. By using Citadel Finance, users gain access to global financial assets on a decentralized network.

Features

  • Synthetic Assets: Mint and trade assets that reflect the price movements of real-world assets.
  • Decentralized: Operates directly on the blockchain, providing a transparent and tamper-proof system.
  • On-chain Liquidity: Uses protocol-managed liquidity pools for trading synthetic assets.
  • User-Friendly Interface: An intuitive interface that enables both novice and advanced users to manage their assets.

How It Works

Citadel Finance mirrors the functionality of Synthereum by leveraging the power of on-chain oracles and liquidity providers:

  1. Oracles: Price data is collected from oracles to keep synthetic assets accurately priced.
  2. Liquidity Pools: Liquidity providers fund these pools, earning fees and helping ensure seamless trading.
  3. Synthetic Assets: Users can mint new synthetic assets by providing collateral, which helps maintain liquidity.

This model enables Citadel Finance to provide synthetic assets representing anything from fiat currencies to commodities and other financial instruments.

Getting Started

Prerequisites

  • Foundry: Follow the installation guide at Foundry’s official documentation.
  • Git: Necessary for cloning the repository.
  • BSC Wallet (e.g., MetaMask): Required for testing the protocol.

Installation

  1. Clone the repository:

    git clone https://github.com/YOUR-USERNAME/Citadel-Finance.git
cd Citadel-Finance

  2. Install dependencies:

    forge install

  3. Compile the smart contracts:

    forge build

Usage

Running a Local Development Node

To test Citadel Finance locally, you can use a BSC-compatible local environment (e.g., Anvil from Foundry):

  1. Start a local node with Anvil:

    anvil

  2. Deploy the contracts to the local network:

    forge script scripts/Deploy.s.sol --fork-url http://localhost:8545 --broadcast

Interacting with Citadel Finance

After deploying the protocol, you can interact with it through:

  • Frontend Interface: The frontend interface allows you to interact with the protocol through your web browser.
  • Command Line: Use commands to interact directly with the contracts if needed.

Contributing

We welcome contributions to Citadel Finance! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature (git checkout -b feature-branch).
  3. Commit your changes (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a Pull Request.

For larger contributions, please open an issue first to discuss the proposed change.

License

Citadel Finance is licensed under the MIT License. See LICENSE for more details.

Acknowledgments

Citadel Finance is built as a fork of Synthereum by Jarvis Protocol, with significant inspiration and foundational code. Huge thanks for their work.