GET/deployed-contracts-endpoint

[palit-pratyush]

🚀 Pull Request Description

Description

Implement GET /deployed_contracts Endpoint

Overview

This PR implements the /deployed_contracts endpoint to fetch deployed contracts with metadata, along with a supporting POST endpoint for contract creation. The implementation includes robust filtering, sorting, pagination, and rate limiting capabilities.

Key Features

• GET /deployed_contracts

  • Filtering by name and address (case-insensitive)
  • Sorting by any field (e.g., deployment_date:desc)
  • Pagination with limit and skip parameters
  • Rate limited to 60 requests/minute
  • Comprehensive error handling

• POST /contracts

  • Create new contract records
  • Strict input validation
  • Rate limited to 10 requests/minute
  • Unique address constraint

Technical Implementation

Database

• Added ContractDB SQLAlchemy model with:
  • id: Auto-incrementing primary key
  • name: String, indexed
  • address: String, unique, indexed
  • deployment_date: DateTime

API Models

• Contract: Response model
• ContractCreate: Request validation model
• DeployedContractsResponse: Paginated response model

Validation

• Contract address must be a valid Ethereum address (0x + 40 hex chars)
• Contract name length: 1-100 characters
• Rate limiting using slowapi
• Unique address constraint at database level

Example Usage

# Get all contracts with pagination
GET /api/deployed_contracts?limit=10&skip=0

# Filter by name
GET /api/deployed_contracts?name=Token

# Sort by deployment date
GET /api/deployed_contracts?sort_by=deployment_date:desc

# Create a new contract
POST /api/contracts
{
    "name": "My Contract",
    "address": "0x1234567890123456789012345678901234567890",
    "deployment_date": "2025-08-29T12:00:00Z"
}

🔗 Linked Issues

• Fixes Implement GET /deployed_contracts Endpoint #453

✅ What’s New

• Added comprehensive test suite covering:
  • ✅ Contract creation
  • ✅ Contract listing with filters
  • ✅ Sorting functionality
  • ✅ Pagination
  • ✅ Rate limiting
  • ✅ Error cases
  • ✅ Input validation

📚 Documentation

• Added OpenAPI tags and descriptions
• Added detailed docstrings
• Added example requests and responses
• Documented error handling scenarios

📦 Dependencies Added

• slowapi – for rate limiting
• httpx – for HTTP-based testing
• pytest-asyncio – for async test support

🛠 Migration

• No database migrations needed (new feature only)

⚡ Performance Considerations

• ✅ Added DB indexes for commonly queried fields
• ✅ Implemented efficient pagination
• ✅ Configured rate limiting to prevent abuse

🔐 Security

• ✅ Input validation for all parameters
• ✅ Rate limiting to prevent DoS attacks
• ✅ Error messages do not leak internal details

🔗 Related Issues

• Closes Implement GET /deployed_contracts Endpoint #453

---

✅ Checklist

• Tests added and passing
• API documentation updated
• Input validation implemented
• Rate limiting configured
• Error handling implemented
• Database indexes added
• Code follows project style
• No breaking changes

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
stark-finder-mq45	Ready	Preview	Comment	Aug 28, 2025 9:59pm

[Caffeine-Connoisseur]

@palit-pratyush run

  poetry run black 
  poetry run isort 

to fix lint issues

[PoulavBhowmick03]

@palit-pratyush kindly resolve the conflicts

[tosoham]

Fix merge conflicts