Skip to content
This repository was archived by the owner on Dec 29, 2023. It is now read-only.

Smart contract for integrating robust stop loss and take profit functionalities into Elys Network

License

Notifications You must be signed in to change notification settings

elys-network/trade-shield-contract

Repository files navigation

TradeShield Contract

TradeShield is a repository hosting a smart contract for implementing stop loss and limit sell functionalities on the Elys Network blockchain. This repository provides a robust and customizable solution for integrating advanced risk management mechanisms into decentralized applications.

Specifications

The docs folder in this repository contains detailed specifications for implementing stop loss and limit sell functionalities using the TradeShield smart contract. It includes comprehensive documentation and guidelines to assist developers in understanding and utilizing these features effectively.

Smart Contract Framework

TradeShield smart contracts are built using the CosmWasm framework, which provides a secure and efficient environment for executing WebAssembly-based smart contracts. These contracts are specifically designed for compatibility with Cosmos SDK 0.47 and the Elys Cosmos Modules.

Features

Spot Order

A spot order is fulfilled when the specified price set by the trader aligns with the prevailing market price, prompting the immediate execution of the purchase or sale of a financial asset.

  • Stop Loss Functionality: Enable users to set automated orders that trigger when the asset's price reaches a specified lower limit, minimizing potential losses.
  • Limit Sell Functionality: Allow users to set automated orders that execute when the asset's price reaches a specified upper limit, securing profits.
  • Limit Buy Fuctionality: Allow users to set automated orders that execute when the limit price is reaches, securing profits.
  • Market Buy Fuctionality: Allow users to set automated orders that will execute at market price

Margin Order

A margin order involves trading an asset using funds provided by a third party. It allows users to trade larger positions with a smaller initial capital outlay.

  • Stop Loss Functionality: Enable users to set automated orders that trigger when the asset's price reaches a specified lower limit, minimizing potential losses.
  • Limit Sell Functionality: Allow users to set automated orders that execute when the asset's price reaches a specified upper limit, securing profits.
  • Limit Buy Fuctionality: Allow users to set automated orders that execute when the limit price is reaches, securing profits.
  • Market Buy Fuctionality: Allow users to set automated orders that will execute at market price

Getting Started

To start using TradeShield, follow these steps:

  1. Clone this repository to your local development environment.
  2. Navigate to the docs folder to access the detailed specifications and guidelines for implementing stop loss and limit sell functionalities.
  3. Ensure you have the required dependencies, including the CosmWasm framework, Cosmos SDK 0.47, and the Elys Cosmos Modules.
  4. Review the example implementations provided in the repository to understand the integration process.
  5. Customize and deploy the TradeShield smart contracts according to your specific project requirements.

Contributing

We welcome contributions from the community to enhance TradeShield's functionality and usability. If you would like to contribute, please follow the guidelines outlined in the CONTRIBUTING.md file.

License

TradeShield is released under the Apache License. You are free to use, modify, and distribute this software as per the terms of the license.

Issue Tracker

If you encounter any issues, bugs, or have any suggestions for improvement, please open an issue on the Issue Tracker. We appreciate your feedback and will address the concerns as soon as possible.