# EOS Network Foundation Grant Proposal

> This document will be part of the terms and conditions of your agreement and therefore needs to contain all the required information about the project.
>
> See the [Grant Framework Process](https://github.com/eosnetworkfoundation/grant-framework#grant-process-for-new-proposals) on how to submit a proposal.
>
> Please do not remove any of the mandatory lines that start with **bold labels** or as headlines! Your application will be rejected!
>
> Please do not remove the bolding of labels (such as **Bold Label:** ) as it is needed by the automated parsers - that includes the bolding on lines starting with a bullet as part of a list.
>
> Please note that this application will be **automatically parsed**. Please only put the data required in the fields following the bolded labels.
>
> Deleting lines that start with **Bold Labels:** will cause your grant to be rejected! Please fill this out carefully if you want to be approved!
>
> All "comment" lines starting with a `>` (such as this one and the ones above and below) should be removed.

- **Project Name:** Name of your project (e.g. Anchor Wallet)
- **Team Name:** Legal name of your team (e.g. Greymass, Inc.)
- **EOS Payment Address:** EOS payment address
- **[Level](https://github.com/eosnetworkfoundation/grant-framework#grant-levels):** 1, 2 or 3
- **Pomelo Grant(s):** List URL(s) to Pomelo grants for your team (or list N/A for non-applicable)
- **Project is Open-Source:** Yes/No
- **Project was part of Token sale:** Yes/No
- **Repository where Project resides:** https://github.com/<your_organisation>/<project_repo>
> Please only answer Yes or No to the Open-Source or Token sale questions. Do not explain more on that line. You may delete this line and all lines that begin with `>` from your application.

## Contact

- **Contact Name:** Full name of the contact person in your team
- **Contact Email:** [e-mail]
- **Website:** https://yourwebsite.com

> ⚠️ *The combination of your GitHub account submitting the application and the EOS account address above will be your unique identifier during the program. Please keep them safe.*

## Project Overview

> If this is an application for a follow-up grant (the continuation of an earlier, successful ENF grant), please provide name and/or pull request of said grant on the first line of this section.

### Overview

> Please provide the following:

- **Name:** If the name of your project is not descriptive, a tag line (one sentence summary).
- **Brief Description:** A brief description of your project.
- **Relationship to EOS Network / Antelope:** An indication of how your project relates to / integrates into the EOS Network or Antelope software.
- **Reason for Interest:** An indication of why your team is interested in creating this project.

### Project Details

> We expect the teams to already have a solid idea about your project's expected final state. Therefore, we ask the teams to submit (where relevant):

- Mock-ups/designs of any UI components
- Data models of the core functionality
- API specifications of the core functionality
- An overview of the technology stack to be used
- Documentation of core components, protocols, architecture, etc. to be deployed
- PoC/MVP or other relevant prior work or research on the topic
- What your project is _not_ or will _not_ provide or implement
- This is a place for you to manage expectations and to clarify any limitations that might not be obvious

### Ecosystem Fit

> Help us locate your project in the EOS Network landscape and what problems it tries to solve by answering each of these questions:

- Where and how does your project fit into the ecosystem?
- Who is your target audience (chain/dapp/wallet/UI developers, designers, your own user base, some dapp's userbase, yourself)?
- What need(s) does your project meet?
- Are there any other projects similar to yours in the EOS Network / Antelope ecosystem?
- If so, how is your project different?
- If not, are there similar projects in related ecosystems?

## Team

### Team members

- **Team Leader:** Name of team leader
- Name of team member 1
- Name of team member 2
- Name of team member 3, etc.

### Legal Structure
- **Registered Legal Entity:** Name of your registered legal entity. (e.g. Greymass, Inc.)
- **Registered Address:** Address of your registered legal entity. Please keep it in a single line. (e.g. 123 Main Street, London LK1 234, UK)

### Team Experience

> Please describe the team's relevant experience. If your project involves development work, we would appreciate it if you singled out a few interesting projects or contributions made by team members in the past. For research-related grants, references to past publications and projects in a related domain are helpful. If you applied for a Pomelo grant in the past, please be sure you listed them in the section above and mention them in detail in this section.

> If anyone on your team has applied for a grant at the EOS Network Foundation previously, please list the name of the project and legal entity here.

### Team Org Repos

- https://github.com/<your_organization>
- https://github.com/<your_organization>/<project_1>
- https://github.com/<your_organization>/<project_2>

> Please also provide the GitHub accounts of all team members. If they contain no activity, references to projects hosted elsewhere or live are also fine.

### Team Member Repos

- https://github.com/<team_member_1>
- https://github.com/<team_member_2>

### Team LinkedIn Profiles (if available)

- https://www.linkedin.com/in/<person_1>
- https://www.linkedin.com/in/<person_2>

## Development Status

> If you've already started implementing your project or it is part of a larger repository, please provide a link and a description of the code here. In any case, please provide some documentation on the research and other work you have conducted before applying. This could be:

- links to improvement proposals or [RFPs](https://github.com/eosnetworkfoundation/grant-framework/tree/main/docs/rfps) (requests for proposal),
- academic publications relevant to the problem,
- links to your research diary, blog posts, articles, forum discussions or open GitHub issues,
- references to conversations you might have had related to this project with anyone from the EOS Network Foundation,
- previous interface iterations, such as mock-ups and wireframes.

## Development Roadmap

This section should break the development roadmap down into milestones and deliverables. To assist you in defining it, we have created a document with examples for some grant categories [here](../docs/grant_guidelines_per_category.md). Since these will be part of the agreement, it helps to describe _the functionality we should expect in as much detail as possible_, plus how we can verify and test that functionality. Whenever milestones are delivered, we refer to this document to ensure that everything has been delivered as expected.

Below we provide an **example roadmap**. In the descriptions, it should be clear how your project is related to the EOS ecosystem. We _recommend_ that teams structure their roadmap as 1 milestone ≈ 1 month.

For each milestone,

- make sure to include a specification of your software. _Treat it as a contract_; the level of detail must be enough to later verify that the software meets the specification.
- include the amount of funding requested _per milestone_.
- include documentation (tutorials, API specifications, architecture diagrams, whatever is appropriate) in each milestone. This ensures that the code can be widely used by the community.
- provide a test suite, comprising unit and integration tests, along with a guide on how to set up and run them.
- commit to providing Dockerfiles for the delivery of your project.
- indicate milestone duration as well as number of full-time employees working on each milestone.
- **Deliverables 0a-0c are mandatory for all milestones**, and deliverable 0e at least for the last one. If you do not intend to deliver one of these, please state a reason in its specification (e.g. Milestone X is research oriented and as such there is no code to test).

> :zap: If any of your deliverables is based on someone else's work, make sure you work and publish _under the terms of the license_ of the respective project and that you **highlight this fact in your milestone documentation** and in the source code if applicable! **Teams that submit others' work without attributing it will be immediately terminated.**

### Milestone Summary

> Note: the numbers in the three lines below are examples. Please replace with your own calculations! Then delete this instruction line.
> You **must** keep these three Milestone Summary lines below for your grant to be approved. The Total Cost should add up to the costs
> of all of your Milestones. Please **DO NOT** remove the three lines below. If you do, your grant will be rejected or delayed while you fix it.
- **Total Estimated Duration:** 2 months
- **Full-Time Equivalent (FTE):** 2 FTE
- **Total Costs:** 12,000 USD

> Please note that this application is automatically parsed.<br/>
> For the above fields, please only put the answer on that line. If you want to add more information, please put it below these instructions.<br/>
> Please remember to delete all lines that start with `>` as they are just instructions and not needed in the application submission.<br/>
>
> Notes on above fields:
> - Total Estimated Duration: Duration of the whole project (example: 2 months or 7 weeks)
> - Full-Time Equivalent (FTE): This is the average number of full-time employees working on the project throughout its duration (see [Wikipedia](https://en.wikipedia.org/wiki/Full-time_equivalent), example: 2 FTE or possibly 2.5 FTE as it is an average)
> - Total Costs: This should be the requested amount in USD for the whole project (example 12,000 USD). Note that the acceptance criteria and additional benefits vary depending on the [level](../README.md#grant-levels) of funding requested. This and the costs for each milestone need to be provided in USD; if the grant is paid out in EOS, the amount will be calculated according to the exchange rate at the time of payment.

### Milestone 1 Example — Implement EOS Application

- **Estimated duration:** 1 month
- **FTE:** 2
- **Costs:** 8,000 USD

| ID | Deliverable | Specification |
| ----- | ----------- | ------------- |
| 0a. | License | MIT / Apache 2.0 / GPLv3 / Unlicense |
| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) spin up one of our EOS nodes and send test transactions, which will show how the new functionality works. |
| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. |
| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 0e. | Article | We will publish an **article**/workshop that explains [...] (what was done/achieved as part of the grant). (Content, language and medium should reflect your target audience described above.)
| 1. | Application interface to Antelope | We will create an integration layer ... (Please list the functionality that will be implemented for the first milestone) |
| 2. | Front-End / User Interface | We will create a UI that connects to ... |
| 3. | Caching layer | We will create a caching layer ... |
| 4. | API interface to our app | We will create an API that ... |

### Milestone 2 Example — Additional features

- **Estimated Duration:** 1 month
- **FTE:** 2
- **Costs:** 4,000 USD

| ID | Deliverable | Specification |
| ----- | ----------- | ------------- |
| 0a. | License | MIT / Apache 2.0 / GPLv3 / Unlicense |
| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) spin up one of our EOS nodes and send test transactions, which will show how the new functionality works. |
| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. |
| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 0e. | Article | We will publish an **article**/workshop that explains [...] (what was done/achieved as part of the grant). (Content, language and medium should reflect your target audience described above.)
| 1. | Performance Enhancements | We will create performance enhancements to ... (Please list the functionality that will be implemented for the first milestone) |
| 2. | Added UI functionality | We will add UI functionality to... |
| 3. | Add 3rd Party API integration | We will add 3rd party integration to ... |

... Add more milestones as above as needed ...

## Future Plans

> Please include here:

- how you intend to use, enhance, promote and support your project in the short term, and
- the team's long-term plans and intentions in relation to it.

## Additional Information

**How did you hear about the Grants Program?** EOS Network Foundation Website / Medium / Twitter / Element / Announcement by another team / personal recommendation / etc.

> Here you can also add any additional information that you think is relevant to this application but isn't part of it already, such as:

- Work you have already done.
- If there are any other teams who have already contributed (financially) to the project.
- Previous grants you may have applied for.