Open secretchaingirl opened 2 years ago
Will reach out via Discord and set up a group with Yonatan and I.
Based on feedback from the community, we would like to make the following modifications to the proposal:
Those changes will help to lower the cost of the proposal and lessen the impact of converting SCRT to sUSDC for milestone payments.
We anticipate milestones 2 & 3 to be covered under Secret University funding at a later phase.
@JayScrtNetwork - let me know if it's okay to modify the proposal to reflect these changes? 🙏
Thank you for taking the time to address the community feedback and consider these modifications. Feel free to modify the proposal at this time. Looking forward to discussing this in greater detail. Cheers
Updated! 🎉
A couple more updates:
Secret Boxes
Project Description
This is a grant application for a set of templates called "secret boxes": Secret Network Grant Program: Developer Tools
We intend to create a home for developer quickstarts on Secret, intended to help developers get building fast. Secret boxes are inspired by Ethereum’s Truffle framework which has created Truffle Boxes. The boxes are self-contained code, tutorial and other documentation needed launch or unbox in a container-based environment. Where Truffle Boxes are mainly beautifully written tutorials with template code, Secret Boxes are actually launchable in addition to having a tutorial or guide on what's going on in the template code.
An example of this idea can be found at NEAR Learn: Rust & AssemblyScript Code Examples for building on NEAR.
Our team is excited to be part of the ongoing initiatives to improve the developer experience in Secret. While this proposal is geared toward getting the project off the ground, we envision this as a longer-term project within the "Secret University" effort, with potentially many developers and designers working together to create awesome secret boxes.
Problem / Solution
There is a large amount of documentation, code repositories and examples in Secret. For new or even existing developers, there really isn't a quick, easy way to start building a secret contract or Secret App. The process involves quite a bit of time hunting around for examples, explanations, and guides, often finding things done in different ways, which can be overwhelming and confusing.
Secret Boxes solve that problem by being self-contained with all the information and guidance needed, including best practices (gas optimization). The boxes can be anything that might help a developer gain an understanding of working with secret contracts and integrations including:
To help developers focus only on building, each secret box will also be deployed with a useful, well-designed UI/UX. This frontend will act as a great starting point for projects and will also allow developers to easily evolve and iterate as the needs of their project change.
Another example that illustrates the idea of Secret Boxes can be found in this Terra template that launches in Code Sandbox, and includes a very basic frontend: terra-money/wallet-provider - CodeSandbox.
Each accompanying tutorial will include descriptions, tips, and a discrete set of steps or instructions to modify the secret box code. Thus making it easy to quickly launch and experiment with a Secret App. In addition, the secret box tutorial will include the complete instructions for working in a local developer environment (and all the setup and configuration involved) and deploying to testnet and mainnet.
Detailed project description
The Secret Boxes project is composed of the following:
The Proof of Concept (PoC) for secret boxes can be found here: secretboxes website.
In collaboration with Secret University members we have developed the following detailed plan for the project. To determine the specific secret boxes to be developed we created a developer survey, which had a total of 19 responses from existing developers in the Secret ecosystem. A detailed report on the survey results can be viewed here: Secret Boxes Survey - Findings.
Summary of the developer survey findings:
The majority of survey respondents expressed interest in DeFi use cases, followed closely by secret NFTs.
A whopping 71% said guidance on architectural considerations was important to them.
Planned Secret Boxes
Based on the survey findings, our plan is to implement the following secret boxes as part of this project:
Hello World - A fun way for developers to quickly learn about working with secret contracts.
This box is currently under development as the PoC for launching a gitpod workspace that does all the heavy lifting in terms of building, deploying, and launching a simple Secret App: hello-world-secret-box.
Secret Counter - based on the SCRT Labs' secret contract template, with the counter increment/decrement functionality. Will include a deeper dive on the structure of the counter secret contract, messages, storage, etc.
The intent of this "beginner" secret box is to get developers familiar with the basic secret contract structure, with much more explanation of what's going on in the code.
Richie Rich - this secret box is inspired by the original Enigma tutorial, Yao's Millionaires Problem, which showcases the real value of building on Secret--the ability to keep data private. Also, should include the usage of viewing keys/permits and guidance on when and how to use them.
In this scenario, two millionaires wish to know who is richer without revealing their actual wealth to the world.
Fund Me - a very simple, and fun Secret App that includes a walkthrough for creating a SNIP-24 token using
secret.js
.Secret Factory - a factory contract and an offspring contract where factory can be used to create new offspring contracts. This is a very common design pattern used by many dapps such as Secret Auctions and NFT marketplaces.
Secret Lending - a DeFi use case, offspring contract from Secret Factory, illustrating a number of more advanced topics including working with SNIP-24 tokens.
Secret RNG - on-chain random number generator.
Secret NFT - geared toward developers that want to learn how to create an NFT contract on Secret.
Secret Voter - a more complex secret box to showcase private voting with a DAO and will also include data storage considerations and best practices.
Secret Dice - a fun dice game with privacy, only possible on Secret.
Because secret boxes can be used to cover anything from a developer lesson on viewing keys and cross-contract calls to full-blown Secret App blueprints (like an NFT marketplace), we envision the future direction of the project to include many more boxes, and a community of contributors.
We believe that along with the developer documentation improvements currently underway, and the Secret University Learning Paths, secret boxes will add another arsenal in the toolbox for onboarding new developers and making sure the developer experience is fun, quick and easy.
Go-to-Market plan
Although there is a clear value proposition to the Secret ecosystem, onboarding new developers and helping them get up-to-speed quickly, this project does not have a clear path for revenue. Because it is of a strictly educational nature, we strongly believe that it should get future funding from the Secret University, which we hope will also get funding under the leadership of the Secret University.
Value capture for Secret Network ecosystem
The real value for the Secret ecosystem is in the number of developers that are able to benefit from the secret box quickstarts. We plan to capture that information through developer feedback.
Team members
Within the
Secret University | secret-boxes
discord channel we have gathered interested developers, designers, etc. who have expressed interest in working on the website and the planned secret boxes (listed above).Due to resource constraints with the availability of team members, it may be necessary to recruit more developers, designers, etc. to complete the boxes planned in this proposal. We may also go to the Design committee to help with the UI/UX for the secret boxes. We plan on coordinating with the Secret Foundation to help with growth and awareness as well.
Team Website
Team Code Repos
https://github.com/secretchaingirl/secretboxes.io
https://github.com/secretchaingirl/secret-hello-world-box-vuejs
Development Roadmap
We will require 3 months to complete this project using 6 developers part-time, 2 UI/UX designers part-time, 1 graphics designer part-time at a cost of $113,000.
Alex - 10 hrs/wk ChrisR - 10 hrs/wk Sandman - 10 hrs/wk DDT - 10 hrs/wk Kent - 10 hrs/wk Jeff (UI/UX lead) - 10 hrs/wk Lois (Jeff's staff) UI/UX - 10 hrs/wk Kate - 10 hrs/wk Laura - 10 hrs/wk
Additionally, we are requesting a discretionary fund amount to be able to handle payment for developers to create additional guides, tutorials, best practices, etc., which may fall outside of a secret box, but are still critical to improving the developer experience within Secret.
The discretionary funding cost is estimated to be $17,000 and covers the creation of 10 guides (20 hrs per guide).
Milestone 1 (0 - 4 weeks): Implement 1st set of Secret Boxes (3) - Cost: $34,000
Milestone 2 (4 - 8 weeks): Implement 2nd set of Secret Boxes (3) - Cost: $45,000
Milestone 3 (8 - 12 weeks): Implement 3rd set of Secret Boxes (3) and finish website - Cost: $44,000
Ideally, we can receive payments in 3 disbursements, one prior to each Milestone, using the "Cost" stated for each milestone above.
We are willing to be paid 100% in SCRT using the USD price prior to each Milestone payment. On receipt, 80% of the SCRT funded will be converted to sUSDC.
Post-Grant and Beyond
To support the secret boxes, providing guidance, answering questions, troubleshooting, we will be recruiting and hiring developers. Our vision is to have a developer recruit work with the secret box author to learn and provide support, eventually becoming a secret box author themselves.
In addition, we will need to recruit community members to help with the creation of a developer-focused secret boxes newsletter using Mailchimp, which can also be used for developer outreach for things like Secret conferences, spaces, hackathons and more.
The next steps for secret boxes after completing all grant milestones will be to integrate the boxes into the Secret University initiative, and adding these tasks/roles:
Newsletter design and implementation
Ongoing implementation of newsletter (full-time role). This role will involve staying in the loop on developer initiatives, events, workshops, tutorials, tips, ecosystem projects, etc. and using that as input to create the weekly newsletter for Secret developers.
Recruit and implement support team (6 developers to cover various timezones part-time)
Ongoing creation of developer guides, tips, best practices, etc.
The post-grant funding is expected to come from the Secret University treasury, so we can continue to evolve secret boxes along with the learn pathways, courses, workshops and the developer experience overall.
Additional Information
N/A.