Skip to content

QuickLendX/quicklendx-protocol

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

795 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

QuickLendX Protocol

Rust Soroban Next.js License

QuickLendX is a decentralized invoice financing protocol built on Stellar's Soroban platform. It enables businesses to access working capital by selling their invoices to investors through a transparent, secure, and efficient blockchain-based marketplace.

🎯 What is QuickLendX?

QuickLendX revolutionizes invoice financing by leveraging blockchain technology to create a trustless, efficient marketplace where:

  • Businesses can upload verified invoices and receive immediate funding from investors
  • Investors can discover, evaluate, and bid on invoices with competitive rates
  • All parties benefit from automated escrow, transparent audit trails, and comprehensive analytics

Built on Stellar's Soroban smart contract platform, QuickLendX provides enterprise-grade features including KYC/verification, dispute resolution, insurance options, and comprehensive reportingβ€”all while maintaining the security and transparency of blockchain technology.

πŸ‘₯ Who is this for?

  • Small and Medium Businesses (SMBs): Companies seeking flexible working capital solutions without traditional banking constraints
  • Investors: Individuals and institutions looking for alternative investment opportunities with transparent risk assessment
  • DeFi Enthusiasts: Users interested in decentralized finance applications on the Stellar network
  • Developers: Contributors looking to build on or extend the QuickLendX protocol

πŸ—οΈ Project Structure

quicklendx-protocol/
β”œβ”€β”€ quicklendx-contracts/    # Soroban smart contracts (Rust)
β”‚   β”œβ”€β”€ src/                 # Contract source code
β”‚   β”œβ”€β”€ Cargo.toml          # Rust dependencies
β”‚   └── README.md           # Contracts documentation
β”‚
└── quicklendx-frontend/     # Next.js web application
    β”œβ”€β”€ app/                 # Next.js app directory
    β”œβ”€β”€ package.json         # Node.js dependencies
    └── README.md           # Frontend documentation

πŸš€ Quick Start

Prerequisites

Installation

  1. Clone the repository
git clone https://github.com/your-org/quicklendx-protocol.git
cd quicklendx-protocol
  1. Set up Smart Contracts
cd quicklendx-contracts
cargo build
cargo test
  1. Set up Frontend
cd ../quicklendx-frontend
npm install

Environment Setup

Smart Contracts

Create a .env file in quicklendx-contracts/ (optional for local development):

# Network Configuration
NETWORK=testnet
CONTRACT_ID=your_contract_id_here

# Account Configuration
ADMIN_ADDRESS=your_admin_address

Frontend

Create a .env.local file in quicklendx-frontend/:

# API Configuration
NEXT_PUBLIC_CONTRACT_ID=your_contract_id_here
NEXT_PUBLIC_NETWORK=testnet
NEXT_PUBLIC_RPC_URL=https://soroban-testnet.stellar.org:443

Running the Project

Start Local Soroban Network

stellar-cli network start

Deploy Contracts (Local)

cd quicklendx-contracts
cargo build --target wasm32-unknown-unknown --release
stellar-cli contract deploy \
    --wasm target/wasm32-unknown-unknown/release/quicklendx_contracts.wasm \
    --source admin

Start Frontend Development Server

cd quicklendx-frontend
npm run dev

Open http://localhost:3000 in your browser.

WASM build and size budget

The contract must stay within the network deployment size limit (256 KB). You can run the script and/or the integration test:

Option 1 – Script (builds with Stellar CLI or cargo):

cd quicklendx-contracts
./scripts/check-wasm-size.sh

Option 2 – Integration test (builds with cargo, then asserts size):

cd quicklendx-contracts
cargo test wasm_release_build_fits_size_budget

Both build the contract for Soroban (release, no test-only code) and fail if the WASM exceeds 256 KB. CI runs the script on every push/PR.

Testing

Test Smart Contracts

cd quicklendx-contracts
cargo test

Test Frontend

cd quicklendx-frontend
npm run test  # If tests are configured
npm run lint

Network Deployment

Testnet Deployment

# Configure for testnet
stellar-cli network testnet

# Deploy contract
stellar-cli contract deploy \
    --wasm target/wasm32-unknown-unknown/release/quicklendx_contracts.wasm \
    --source <YOUR_ACCOUNT> \
    --network testnet

Mainnet Deployment

⚠️ Important: Mainnet deployment requires thorough testing and security audits.

stellar-cli contract deploy \
    --wasm target/wasm32-unknown-unknown/release/quicklendx_contracts.wasm \
    --source <DEPLOYER_ACCOUNT> \
    --network mainnet

πŸ“š Documentation

πŸ”— Helpful Links

Stellar & Soroban

Development Resources

Project Resources

πŸ›οΈ Architecture Overview

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   Frontend      β”‚    β”‚   Soroban       β”‚    β”‚   Stellar       β”‚
β”‚   (Next.js)     │◄──►│   Smart         │◄──►│   Network       β”‚
β”‚                 β”‚    β”‚   Contracts     β”‚    β”‚                 β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                              β”‚
                    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
                    β”‚   Core Modules  β”‚
                    β”‚                 β”‚
                    β”‚ β€’ Invoice       β”‚
                    β”‚ β€’ Bid           β”‚
                    β”‚ β€’ Payment       β”‚
                    β”‚ β€’ Verification  β”‚
                    β”‚ β€’ Audit         β”‚
                    β”‚ β€’ Analytics     β”‚
                    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

✨ Key Features

  • βœ… Invoice Management: Upload, verify, and manage business invoices
  • βœ… Bidding System: Competitive bidding with ranking algorithms
  • βœ… Escrow Management: Secure fund handling through smart contract escrows
  • βœ… KYC/Verification: Business and investor verification with risk assessment
  • βœ… Audit Trail: Complete transaction history and integrity validation
  • βœ… Analytics & Reporting: Comprehensive metrics and business intelligence
  • βœ… Dispute Resolution: Built-in dispute handling and resolution
  • βœ… Insurance Options: Investment protection mechanisms
  • βœ… Multi-currency Support: Handle invoices in various currencies
  • βœ… Notification System: Real-time updates for all parties

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add tests and ensure they pass
  5. Update documentation
  6. Commit your changes (git commit -m 'Add amazing feature')
  7. Push to the branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

Code Review Process

  1. Automated checks must pass (tests, linting)
  2. Code review by maintainers
  3. Security review for critical changes
  4. Documentation updates required

πŸ“‹ Requirements

Smart Contracts

  • Rust 1.70+
  • Stellar CLI 23.0.0+
  • WASM target: wasm32-unknown-unknown or wasm32v1-none (Soroban)
  • WASM size budget: 256 KB (enforced in CI and via quicklendx-contracts/scripts/check-wasm-size.sh)

Frontend

  • Node.js 18+
  • npm or yarn
  • Modern browser with Web3 support

πŸ§ͺ Testing

Smart Contracts

cd quicklendx-contracts
cargo test
cargo test --profile release-with-logs  # With debug logging

Frontend

cd quicklendx-frontend
npm run test
npm run lint
npm run build  # Production build test

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ‘₯ Contributors

  • Your Name - Initial work

πŸ†˜ Support


Built with ❀️ on Stellar's Soroban platform

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors