Skip to content

README.md

Latest commit

 

History

History
168 lines (129 loc) · 6.47 KB

README.md

File metadata and controls

168 lines (129 loc) · 6.47 KB
Raw

InterChangableTrade-Core

Backend services powering the InterChangableTrade ecosystem on Stellar.

Build and TypeScript Check License: Apache-2.0 Status: active development Network: Stellar testnet

Overview

InterChangableTrade-Core provides the application services that connect the frontend with the Stellar blockchain. It exposes REST APIs, manages business logic, indexes blockchain events, and integrates with Soroban smart contracts — trade execution, asset indexing, settlement, dispute resolution, and analytics for the InterChangableTrade ecosystem.

The project is in active development. All chain access currently targets the Stellar testnet (see Network & Deployment). See the Roadmap for what is coming next and the Changelog for what has shipped.

Features

  • REST API with interactive OpenAPI/Swagger docs
  • Authentication — JWT plus a Stellar wallet challenge-response flow (Ed25519 nonce signing with replay protection)
  • User & wallet management
  • Marketplace & trade execution engine — asset trade listings and matching
  • Stellar integration — Horizon API gateway with connection pooling, rate limiting, and request queuing
  • Soroban contract layer — standardized contract invocation (build → simulate → sign → submit → poll), ABI validation, gas estimation, cached state reads, deployment, and typed error classification
  • Blockchain event indexer — ledger polling with backfill and Soroban contract-event indexing
  • Transaction history
  • Notifications — event-driven, templated
  • Dispute resolution & arbitration — filing, evidence, arbitrator assignment, resolution enforcement, appeals, and SLA tracking
  • Analytics & reporting
  • Resilience & error recovery primitives across modules

Technology Stack

  • NestJS
  • TypeScript
  • PostgreSQL (TypeORM)
  • Redis (ioredis)
  • Stellar SDK (@stellar/stellar-sdk) — Horizon + Soroban RPC

Project Structure

src/
  config/                 Typed configuration, env validation, DB config
  redis/                  Global Redis (ioredis) provider
  modules/
    auth/                 JWT auth, guards, register/login, Stellar wallet auth
    users/                User management
    wallet/               Wallet management
    marketplace/          Asset trade listings
    trading/              Trade domain
    trading-engine/       Trade execution
    assets/               Stellar asset indexing
    transactions/         Transaction history
    stellar/              Stellar (Horizon) gateway + Soroban integration
    blockchain-indexer/   Ledger + contract-event indexing
    notifications/        Event-driven, templated notifications
    dispute-resolution/   Disputes, evidence, arbitration, appeals, SLA
    analytics/            Analytics & reporting
    error-handler/        Centralized error handling
    resilience/           Resilience primitives
    queue/                Background job queue
  main.ts                 Bootstrap, Swagger, global pipes/filters
libs/
  common/                 Shared entities, DTOs, interceptors, filters (@app/common)
scripts/                  Database init and helper scripts

Getting Started

git clone https://github.com/InterChangableTrade/InterChangableTrade-Core.git

cd InterChangableTrade-Core

npm install

# Configure environment (copy and edit)
cp .env.example .env

# Start Postgres + Redis (and optionally the app) via Docker
docker compose up -d postgres redis

npm run start:dev

The API is served under the /api prefix, with interactive OpenAPI docs at http://localhost:3000/api/docs.

Scripts

npm run start:dev     # Watch-mode development server
npm run build         # Compile to dist/
npm run test          # Unit tests
npm run test:e2e      # End-to-end tests
npm run lint          # Lint and auto-fix

Docker

docker compose up --build    # Build and run app + Postgres + Redis

Network & Deployment

The service defaults to the Stellar testnet:

Setting Default
STELLAR_NETWORK testnet
STELLAR_HORIZON_URL https://horizon-testnet.stellar.org
SOROBAN_RPC_URL https://soroban-testnet.stellar.org

Write invocations and contract deployments require a funded source account via SOROBAN_SOURCE_SECRET; without it the Soroban client runs in read-only mode. Never commit secrets or mainnet credentials — see SECURITY.md.

Documentation

Related Repositories

Contributing

Community contributions are always welcome. Please read:

Use the issue templates to report bugs or request features, and open pull requests against main.

License

Licensed under the Apache License 2.0.