Logo

Submit New Protocol Reviews

Who Can Submit Reviews?

DeFiScan is an open-source project and everyone can create and submit new protocol reviews. We further run initiatives to involve the community more closely in this process and increase coverage of the DeFi sector. Follow us on X or join our Discord to stay up-to-date on any such initiatives.

Getting Started

Follow these steps to create and submit a new protocol review:

  1. Fork the DeFiScan GitHub repository
  2. If you are adding a new protocol:
    1. Copy the template directory to create a new protocol directory (see Repository Structure)
    2. Fill out `data.json` with protocol information
    3. Rename the review file to match your target chain (e.g., ethereum.md, polygon.md)
  3. If you are adding a review for an existing protocol on a new chain:
    1. Copy the template review file to the protocol's directory with the appropriate chain name
  4. Install the Permission Scanner tool
  5. Generate a report of all permissioned functions in the protocol
  6. Complete the protocol review following our methodology
  7. Submit a PR to the main repository
  8. Notify the team in our Discord for review

Review Guidelines

  • Each chain-specific review should focus on the unique aspects and risks of that deployment
  • Include all relevant contract addresses and deployment dates
  • Document all privileged functions and admin capabilities
  • Highlight any differences in implementation across chains
  • Keep the review factual and objective

Repository Structure

All protocol reviews follow this organization:

protocols/
├── protocol-name/
│   ├── data.json    # Protocol metadata and basic information
│   ├── ethereum.md  # Review for Ethereum deployment
│   ├── polygon.md   # Review for Polygon deployment
│   └── base.md      # Review for Base deployment
└── another-protocol/
    ├── data.json
    └── arbitrum.md

Directory Contents

  • data.json - Essential protocol information:
    • Protocol name and description
    • Official website and documentation links
    • Social media links
    • Deployment addresses across different chains
  • <chain>.md - Chain-specific reviews containing:
    • Deployment details and contract addresses
    • Permission analysis results
    • Security considerations
    • Risk assessment

Note: By submitting a PR with a protocol review, you agree that the DeFi Collective may freely use the submitted content. Please see our Terms.