-
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the professional wiki for TradeGuard Shield, a real-time API and browser extension for checking the legitimacy and risk level of trading websites.
TradeGuard Shield is an automated threat intelligence API and browser extension designed to evaluate, verify, and score the legitimacy and risk level of online trading platforms in real time.
Architecture & Monorepo Structure
The project is structured as a high-performance TypeScript monorepo managed via pnpm:
-
apps/api: Fastify REST API serving risk assessment requests, report persistence, and browser extension endpoints. -
packages/security: URL validation engine, SSRF protection filters, host sanitization, and security headers. -
packages/logger: Structured JSON logging utility with automatic sensitive data redaction (redactSensitive). -
packages/testing: Vitest test suites, fixtures, and execution harnesses. -
services/collector: Service responsible for gathering OSINT, domain heuristics, and SSL/TLS validation metadata. -
services/worker: Asynchronous task runner processing background risk updates.
Security & Hardening Standards
-
Input Validation: All target URLs pass through
validatePublicHttpUrl()to block internal IPs, private TLDs, and non-HTTP protocols before analysis. - Automated CI/CD: Strict GitHub Actions workflows enforce TypeScript compilation, unit testing via Vitest, and dependency vulnerability auditing.
- Dependency Monitoring: Dependabot rules automatically patch known CVE vulnerabilities across dependencies.
Developer Quickstart
-
Clone and Install:
git clone [https://github.com/Ciprian-LocalPulse/tradeguard-shield.git](https://github.com/Ciprian-LocalPulse/tradeguard-shield.git) cd tradeguard-shield pnpm install
- System Overview
- Architecture
- Scoring Model
- Data Sources
- Browser Extension
- API Reference
- Deployment
- Security Model
- Roadmap
- Governance
TradeGuard Shield helps users identify suspicious trading websites before they deposit money, submit identity documents, or connect wallets.
flowchart LR
User[Retail trader] --> Browser[Browser Extension]
Browser --> API[TradeGuard API]
API --> Score[Explainable Risk Score]
Score --> Badge[Green, Yellow, or Red Badge]
Badge --> User
- Author: Ciprian Ștefan Pleșca
- License: MIT
- Primary stack: TypeScript, Fastify, React, Manifest V3, Docker
This repository is an open-source project and encourages contributions. Please see the CONTRIBUTING.md file for guidelines on how to report issues or submit pull requests.
This project is licensed under the terms of the MIT License. See the LICENSE file for full details.
Copyright (c) 2024 Ciprian-LocalPulse
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (hereinafter referred to as the "Software"), to deal in the Software without restriction, including, without limitation, the rights to use, copy, modify, merge, publish, distribute, sublicense and/or sell copies of the Software, and to permit persons to whom the Software is provided to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- GitHub Repository: Ciprian-LocalPulse/tradeguard-shield
- Report an Issue: Create a new Issue if you found a bug or have a feature suggestion.