🗄️Competition Submission Template

To start a competition, information about the project and scope is required. Below is a template used to fill in that information. See the cantina.xyz/competitions for examples of projects using this template.

Competition template

# <PROJECT NAME> Competition


## Overview
<PROJECT INFORMATION e.g., what is it, what does it do, what problem it solves,etc..>


## Prize distribution and scoring

Total Prize Pool $ <PRIZE POOL AMOUNT>

- Scoring described in the [competition scoring page](https://docs.cantina.xyz/cantina-docs/enter-the-cantina/cantina-competitions/competition-scoring).
- Findings Severities described in detail on [our docs page](https://docs.cantina.xyz/cantina-docs/finding-severities).
- Only High and Medium findings would be accepted for **Primary Prize Pool**.
- $<LOWER PRIZE POOL AMOUNT> of the total prize pool is reserved for Low Severity or informational findings. These reports are judged based on quality and reviewers are then ranked from 1st to 5th for the purpose of prize allocation:
    * 1st       $<AMOUNT>
    * 2nd       $<AMOUNT>
    * 3rd       $<AMOUNT>
    * 4th       $<AMOUNT>
    * 5th       $<AMOUNT>


## Documentation

<ALL RELEVANT DOCUMENTATION AND LINKS>


## Scope

<SCOPE DESCRIPTION>

- Repository: <TARGET REPOSITORY>
- Commit: <TARGET COMMIT HASH>
- Total LOC: <TOTAL LINES OF CODE IN SCOPE>

| File              | blank | comment | code |
|-------------------|-------|---------|------|
| contracs/File.sol | <X>   |   <Y>   | <Z>  |
| **SUM:**          | <X>   |   <Y>   | <Z>  |


### Out of scope

<OUT OF SCOPE FILES AND FOLDERS>


#### Out of scope automated findings

<CORE TEAM: RUN BOTS TO GENERATE OOS FILES>


## Build Instructions

<DETAILED INSTRUCTIONS TO BUILD THE PROJECT>


## Basic Proof Of Concept

<EXAMPLE OF A POC TO USE AS GUIDELINE>


## Contact Us

For any issues or concerns regarding this competition, please reach out to core-team on discord.

Last updated