Skip to content

Commit

Permalink
Create shield_wallet.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dotshield committed Aug 11, 2023
1 parent af88845 commit da64965
Showing 1 changed file with 138 additions and 0 deletions.
138 changes: 138 additions & 0 deletions applications/shield_wallet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
# EOS Network Foundation Grant Proposal

- **Project Name:** .Shield Wallet
- **Team Name:** Genki
- **EOS Payment Address:** shield.gm
- **[Level](https://github.com/eosnetworkfoundation/grant-framework#grant-levels):** 1
- **Pomelo Grant(s):** https://pomelo.io/grants/shieldchain
- **Project is Open-Source:** Yes
- **Project was part of Token sale:** No
- **Repository where Project resides:** https://github.com/dotshield/shield-extension

## Contact

- **Contact Name:** Cristhian Rincon
- **Contact Email:** [email protected]
- **Website:** https://genki.site

## Project Overview
### Overview

- **Name:** .Shield Wallet (Browser Extension)
- **Brief Description:** EOS EVM wallet with user-friendly interface that allows seamless interaction with the EOS EVM blockchain, enabling users to manage tokens and assets on the EOS EVM network. The wallet will provide secure access to tokens and digital assets on the EOS EVM network.
- **Relationship to EOS Network / Antelope:** The project extends the capabilities of the EOS EVM blockchain by providing a dedicated wallet application for easy token management and transaction execution.
- **Reason for Interest:** We are interested in creating this project to bridge the gap between users and the EOS EVM ecosystem, making it easier for them to manage their assets and participate in the EOS EVM network.

### Project Details

- **Seamless connection to EOS EVM:** Users can connect their wallets to the EOS EVM blockchain using Web3.js for interaction with smart contracts and transactions.
- **Tokens Management:** Users can view and manage their EOS EVM tokens through an intuitive UI.
- **Secure Transactions:** The wallet will provide a user-friendly interface for creating and signing transactions securely.
- **Transaction History:** Users can track and review their transaction history within the wallet.
- **Backup and Recovery:** Users can create encrypted backups of their private keys and implement a secure account recovery process.

### Ecosystem Fit

- Where and how does your project fit into the ecosystem? A: The project fills the need for a dedicated wallet solution for EOS EVM users, providing an easy way to manage tokens and interact with the EOS EVM
- Who is your target audience (chain/dapp/wallet/UI developers, designers, your own user base, some dapp's userbase, yourself)? A: The target audience includes EVM blockchain users, developers building on EOS EVM, and individuals seeking a convenient way to manage their assets on the EOS EVM network.
- What need(s) does your project meet? A: The wallet meets the need for a secure, user-friendly tool for managing EOS EVM assets and participating in the ecosystem.
- Are there any other projects similar to yours in the EOS Network / Antelope ecosystem? A: There are other wallet projects in the EOS Network, but this project differentiates itself by specifically targeting the EOS EVM network, providing a seamless experience for its users.

## Team

### Team members

- **Team Leader:** Cristhian Rincon

### Legal Structure
- **Registered Legal Entity:** Genki (Trademark in registration process)
- **Registered Address:** N/A

### Team Experience

I have developed software development skills and abilities that have allowed me to contribute to and create an open source project called genki, I have several years of experience in the blockchain area, including contributions to blockchain projects. I have previously launched a media portal on EOS and applied for a Pomelo grant for that project.

### Team Org Repos

- https://github.com/dotshield/
- https://github.com/dotshield/shield-extension
- https://blog.genki.site/
- http://129.158.204.90:7800/18f0ab25/

### Team Member Repos

- https://github.com/genkimedia/
- https://github.com/genkimedia/ghost
- https://docs.genki.site/

### Team LinkedIn Profiles (if available)

- https://www.linkedin.com/in/thianandre/

## Development Status
I have conducted preliminary research and analysis of the EOS EVM network, identified key technical requirements, and initiated discussions with potential users to gather feedback. We have not yet started the actual coding.

[Research on the Lack of Dedicated Wallets for the EOS EVM Network](https://docs.google.com/document/d/14BFDqLq84bo75UcaVgfJYEiysKVl9V4gKpSXPEuCp1A/edit?usp=sharing)

## 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).

### Milestone Summary

- **Total Estimated Duration:** 2 months
- **Full-Time Equivalent (FTE):** 1.2 FTE
- **Total Costs:** 10,000 USD

### Milestone 1 — EOS EVM Integration

- **Estimated duration:** 1 month
- **FTE:** 1.2
- **Costs:** 5,000 USD

| ID | Deliverable | Specification |
| ----- | ----------- | ------------- |
| 0a. | License | MIT |
| 0b. | Documentation | API documentation for interacting with EOS EVM network |
| 0c. | Testing Guide | Instructions for running unit and integration tests |
| 1. | EOS EVM Integration | Implement wallet functionality to interact with EOS EVM network by Implement EOS EVM connection using Web3.js |
| 2. | Basic UI | Develop a basic user interface for viewing balances, managing EOS EVM tokensand and executing transactions |

### Milestone 2 — User Interface Enhancements

- **Estimated Duration:** 1 month
- **FTE:** 1.2
- **Costs:** 5,000 USD

| ID | Deliverable | Specification |
| ----- | ----------- | ------------- |
| 0a. | License | MIT |
| 0b. | Documentation | UI component documentation |
| 0c. | Testing Guide | Unit tests with guide on running them |
| 0d. | Docker | Dockerfile for testing |
| 1. | Enhanced UI | Implement advanced UI features for token management, and dApp integration for better user experience |
| 2, | Transaction History | Implement transaction history display |
| 3. | Secure Transactions | UI for creating and signing secure transactions |
| 4. | Improved Interface | Enhance UI/UX design for a polished user experience |

## Future Plans

We intend to actively maintain and support EOS EVM Wallet by incorporating user feedback and improving its features. We also plan to explore integration with decentralized applications based on EOS EVM and contribute to the growth of the EOS EVM ecosystem.

Once we have launched the browser extension, we will incorporate development for desktop and mobile applications.

## Additional Information

**How did you hear about the Grants Program?** EOS Network Foundation Website.

0 comments on commit da64965

Please sign in to comment.