HbarSuite Docs
  • Welcome to HbarSuite
  • HbarSuite Developer Documentation
    • HbarSuite Smart Engine Applications
      • @hsuite/cross-chain-exchange
      • @hsuite/dao
        • DAO Application Testing
      • @hsuite/exchange
      • @hsuite/launchpad
      • @hsuite/multisig
      • @hsuite/nft-exchange
      • HSuite Smart App - Enterprise Hedera Application Framework
    • HSuite Libraries
      • @hsuite/api-key - Enterprise API Key Authentication System
      • @hsuite/auth-types
      • @hsuite/auth - Authentication Module
      • @hsuite/client-types
      • @hsuite/client - Client Service Module
      • @hsuite/dkg-types - Distributed Key Generation Type Definitions
      • @hsuite/hashgraph-types - Hedera Hashgraph Type Definitions
      • @hsuite/health - Comprehensive System Health Monitoring
      • @hsuite/helpers - Utility Library
      • @hsuite/ipfs - InterPlanetary File System Integration
      • @hsuite/shared-types - Shared Type Definitions
      • @hsuite/smart-config - Configuration Management
      • @hsuite/smart-ledgers - Multi-Ledger Management
      • @hsuite/smart-network-types - Smart Network Type Definitions
      • @hsuite/smart-transaction-types - Smart Transaction Type Definitions
      • @hsuite/smartnode-sdk - SmartNode Software Development Kit
      • @hsuite/snapshots - Multi-Ledger Token Snapshot Management
      • @hsuite/subscriptions-types - Subscription Management Type Definitions
      • @hsuite/subscriptions - Enterprise Subscription Management System
      • @hsuite/throttler-types - Rate Limiting Type Definitions
      • @hsuite/throttler - Advanced Rate Limiting for NestJS
      • @hsuite/users-types - User Type Definitions
      • @hsuite/users - User Management Module
      • @hsuite/validators-types
  • General Documentation
    • Smart Apps and Interaction
      • Subscription-Based Model
      • Token-Gate Model
    • The Smart Node Network
      • security-layer
      • Type of Validators Explained
      • Understanding Validators in Our System
      • Automating Responses to Network Changes & Key Rotation
      • Ensuring Continuous Operation and Recovery
      • Generating and Sharing Keys Collaboratively
      • Handling Node Expulsion and Replacement
      • Managing Cluster Membership
      • Protecting Secrets with Shamir's Method
      • Security Layer Integration
      • Setting Up Secure Clusters
    • Tokenomics
      • Tokenomics v1
      • Tokenomics V2
    • What is a Smart Node?
  • Restful APIs Documentation
Powered by GitBook
On this page
  • Applications Overview
  • 1. NFT Exchange
  • 2. Exchange
  • 3. Launchpad
  • 4. Multisig
  • 5. Cross-chain Exchange
  • 6. DAO
  • Directory Structure
  • Development Guidelines
  • Getting Started
  • Contributing
  • Security
  • License
  1. HbarSuite Developer Documentation

HbarSuite Smart Engine Applications

This directory contains the core applications that power the HbarSuite ecosystem. Each application is designed to provide specific functionality while maintaining interoperability with the entire suite.

Applications Overview

1. NFT Exchange

The NFT marketplace application enables users to:

  • List and trade NFTs on the Hedera network

  • Create and manage NFT collections

  • Set royalties and manage secondary sales

  • Participate in NFT auctions

2. Exchange

A decentralized exchange (DEX) platform that provides:

  • Token swapping capabilities

  • Liquidity pool management

  • Automated market making (AMM)

  • Token pair trading

3. Launchpad

A platform for launching new projects and tokens:

  • Token sale management

  • Project vetting and verification

  • KYC/AML compliance tools

  • Fair launch mechanisms

  • Vesting schedule management

4. Multisig

Advanced multi-signature wallet functionality:

  • Multi-party transaction approval

  • Customizable signature thresholds

  • Transaction proposal and voting

  • Key management and recovery

5. Cross-chain Exchange

Facilitates cross-chain asset transfers and trading:

  • Bridge between different blockchain networks

  • Cross-chain token swaps

  • Liquidity management across chains

  • Security protocols for cross-chain transactions

6. DAO

Decentralized Autonomous Organization tools:

  • Governance mechanism implementation

  • Proposal creation and voting

  • Treasury management

  • Community participation tools

Directory Structure

Each application is contained in its own directory:

apps/
├── nft-exchange/       # NFT marketplace implementation
├── exchange/           # DEX platform
├── launchpad/         # Token launch platform
├── multisig/          # Multi-signature functionality
├── cross-chain-exchange/  # Cross-chain trading platform
└── dao/               # DAO governance tools

Development Guidelines

When working with these applications:

  1. Modularity: Each application should be self-contained while utilizing shared libraries

  2. Security: Follow security best practices, especially for financial transactions

  3. Testing: Maintain comprehensive test coverage

  4. Documentation: Keep documentation up-to-date within each application directory

  5. Integration: Ensure smooth integration with other HbarSuite components

Getting Started

Each application has its own setup and configuration requirements. Please refer to the individual README files within each application directory for specific instructions on:

  • Installation

  • Configuration

  • Development setup

  • Testing procedures

  • Deployment guidelines

Contributing

Security

If you discover any security vulnerabilities, please follow the security policy outlined in the root directory and report them responsibly.

License

Please refer to the main project license for terms of use and distribution.


Built with ❤️ by the HbarSuite Team Copyright © 2024 HbarSuite. All rights reserved.

PreviousHbarSuite Developer DocumentationNext@hsuite/cross-chain-exchange

Last updated 4 months ago

We welcome contributions from the community. Please read our for details on our code of conduct and the process for submitting pull requests.

Contributing Guidelines