Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Oruhkl/Dex

Repository files navigation

Dex Protocol

Dex is a decentralized liquidity pool protocol built on the Solana blockchain, enabling users to create liquidity pools, swap tokens, provide liquidity, and stake their assets for rewards. This README provides an overview of the implementation, features, and components of the Soondex protocol.

Features

  • Liquidity Pools: Create and manage liquidity pools for token pairs.
  • Token Swapping: Swap tokens with automated market-making functionality.
  • Liquidity Provisioning: Add and remove liquidity to/from pools.
  • Staking: Stake LP tokens to earn rewards.
  • Admin Management: Manage pool administrators.
  • Reward Claiming: Claim rewards based on staking.

Implementation

Prerequisites

  • Rust programming language
  • Solana CLI
  • Anchor framework

Getting Started

  1. Clone the repository:

    git clone https://github.com/yourusername/soondex.git
    cd soondex
  2. Install dependencies:

    cargo install --git https://github.com/project-serum/anchor anchor-cli --locked
    ed
  3. Build and deploy the protocol:

    anchor build
    anchor deploy
  4. Run the protocol:

    anchor run
  5. Interact with the protocol:

    anchor run

Components

  • Liquidity Pool: A pool of tokens that can be used for swapping.
  • Token: A digital asset that can be swapped.
  • LP Token: A token that represents a user's share of a liquidity pool.
  • Staking: A mechanism for users to earn rewards by providing liquidity.
  • Reward: A token that is earned by staking LP tokens.
  • Admin: A user with special permissions to manage the protocol.
  • Pool: A collection of liquidity pools.
  • Swap: An operation that exchanges one token for another.
  • Liquidity: The amount of tokens in a pool.
  • Stake: An operation that adds LP tokens to a pool.
  • Unstake: An operation that removes LP tokens from a pool.
  • Claim: An operation that claims rewards for staking.

API Endpoints

  • Create Pool: Creates a new liquidity pool.
  • Swap: Swap tokens in a pool.
  • Add Liquidity: Add liquidity to a pool.
  • Remove Liquidity: Remove liquidity from a pool.
  • Stake: Stake LP tokens to earn rewards.
  • Claim Rewards:

License

This project is licensed under the MIT License

Contact

For any questions or inquiries, please contact Orakul.

Acknowledgments

Support

If you find this project helpful, consider supporting the development and maintenance of the Soondex protocol. Your contributions help us improve and expand the protocol's capabilities.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published