OpenBrush
- Team Name: SuperColony
- Payment Address: ERC 20 ADDRESS: 0x112C9eDB60D16f9Cf501721b03B9D0F275682213
Project Overview πβ
Standard proposal - https://github.com/w3f/PSPs/pull/22
Overviewβ
Our mission within this project is to make ink! usable, and achieve its wide adoption.
In order to be successful with this mission, we have outlined several steps that need to be taken.
-
OpenBrush is an open source library for secure smart-contract development on ink! as OpenZeppelin on Solidity.
-
Openbrush should serve as a starting point for every developer entering a Polkadot(ink!) ecosystem.
-
In addition to having a standard implementation, Openbrush should also have macroses to simplify and abstract up applications(smart contracts) development.
-
In order for Openbrush to work and fulfill it's purpose, several changes must be made/several blockers overcome in
ink!
and substrate'scontract-pallet
. We are commited to do that in the context of this project.
This project is important to us as it's our strategic goal to accelerate Polkadot ecosystem development. Applications on Ink! are a huge part of it.
Project Detailsβ
The open brush should be the starting point for smart contract developers from Ethereum. It will contain the same folder structure as openzeppelin and documentation that describes the differences between ink! and Solidity, how developers should change their mindset, how to design their project, how to deploy contract and test them, etc.
The library will provide the default implementation of standard contracts, which can be customized by developers. Also, the library will provide additional features which are not available in ink!(and our team will try to integrate them into ink! later), but which can be useful for development.
Our team aims to improve the smart-contract development experience, and wants to improve ink!, make it more user-friendly and to popularize it.
Ecosystem Fitβ
- Where and how does your project fit into the ecosystem?
The necessity of a solution like this seemed rather urgent to us when we started to work with ink!. We quikcly realized that we strategically would like to become the company that builds in the ecosystem. We decided that we want to commit and help ink! become widespread and used. Right now usability of ink! is very low. Openbrush is dedicated to change that.
- Who is your target audience (parachain/dapp/wallet/UI developers, designers, your own user base, some dapp's userbase, yourself)?
Our target audience are smart contract developers on ink!.
- What need(s) does your project meet?
Our project is the starting point for smart contract developers, coming from other ecosystems like Ethereum, and it aims to improve smart contract development on ink!.
- Are there any other projects similar to yours in the Substrate / Polkadot / Kusama ecosystem?
We are only aware about one project metis. We partnered with them to collaborate on the ecosystem as we have the same commmon end goal.
- If so, how is your project different?
Our project isn't restricted to only providing the base implementation of contracts. Objectively speaking based on what we know, and what was listed in their proposal here are key differences:
- At the moment, Openbrush is in far more advanced stage, Developer Experience of our library is significantly higher
- Openbrush aims to propose and take care of standards for ink! (We've already created PSP for fungible tokens and we plan to cotinue doing so)
- Openbrush aims to be a starting point for a smart contract developer, provide documentation.
- Contribute to ink! and substrate
contract-pallet
to improve the smart-contract development experience(add new features, fix bugs, etc).
Team π₯β
Team membersβ
Markian Ivanichok (Founder & Blockchain Engineer)
Ian Arden (Advisor)
Hartej Sawhney (Advisor)
Dmitry Kryshtal (Marketing and BD)
Green Baneling (Blockchain Core Rust Engineer)
Sven Seven (Fullstack Rust Engineer)
Varg Vikernes (Blockchain Rust Engineer)
Vasyl Novak (Researcher)
Lera Laricheva (Designer)
Contactβ
- Contact Name: Dmitry Kryshtal
- Contact Email: dmitry.kryshtal@supercolony.net
- Website: supercolony.net
Legal Structureβ
- Registered Address: Dubai Silicon Oasis, DDP, Building A2, Dubai, UAE.
- Registered Legal Entity: Mempool Ventures FZCO, operating under Supercolony brand
Team's experienceβ
Markian Ivanichok
CEO of Supercolony,
Blockchain enterpreneur, Software Engineer.
Started my engineering carrer back when I was 15. Since then, I developed and got a lot of experience in engineerig and leadership. Gained entrepreneur experience by founding a couple of startups. Inspired, co-founded and invested in Sector F, one of the top consulting companies in Ukraine that helps enterpreneers to move faster.
Since the beginning of this year, co-founded and led Supercolony, a Polkadot venture studio that is dedicated to building and creating of Polkadotβs ecosystem.
Hartej Sawhney
Co-Founder and President of Hosho, the leading blockchain, and security company that conducts smart contract audits and penetration testing of exchanges and blockchain protocols. He is an advisor at crypto hedge fund, Pink Sky Capital, Krypto.io, and BlitzPredict.io.
Dmitry Kryshtal
Head of Marketing and BD
8 years experienced T-Shaped marketer with a deeper understanding of analytics, creativity and strategy. Opinion leader in the cryptocurrency environment since 2017. Co-owner of the creative agency Citadel. Host of his own program on the biggest crypto-related YouTube channel in CIS β S3XYBTC.
Green Baneling
Blockchain Core Developer
Primary programming languages are: C++, Go, Rust
Finished the faculty of applied mathematic(Master of degree). Participated in programming competitions during education. Has worked as a programmer for around 6 years.
Was a freelancer the first year, creating an application for IOS(Swift), creating modules for the desktop application on C++. After that, spent 2 years in a company which created software for TV devices(C++/ Haxe). After which, for 3 years, worked on different blockchain projects(C++/Go/Rust/Solidity/Js).
Varg Vikernes Junior Blockchain Engineer, Worked in Big Data prior to blockchain, has now switched to developing on Polkadot and doesnβt regret it one bit.
Sven Seven
Fullstack Developer
Software engineer with prod experience since 2015. Master degree Information Security. Has worked in finance, e-commerce, networking domains as full-stack dev. Programming languages are JS, Java, Python, Rust, C++ . Blockchain dev since 2021.
Vasyl Novak
Researcher
BS in economics, MS in Quantitative Finance & Actuarial Science, experienced in, operations management, IB, financial and stratedy consulting, including crypto, passed CFA II level
Lera Laricheva
Creative Designer
"In 2019 I started to get involved in the IT area. At first I tried myself as a developer, and eventually I went away from that, to design. At first I tried myself in design, then when I saw the result, and understood that I liked it, so I found courses and got a diploma. Then I tried freelancing, like many other beginners, but came to the conclusion that the working for a company is much better, and that is where a person can get a tremendous amount of experience, while constantly evolving, because you have to keep up with the tasks, and most importantly to understand them and try to implement them correctly. At the same time, it is my third year studying in Karazin, specialty marketing."
Team Code Reposβ
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.
- https://github.com/VargSupercolony
- https://github.com/sventime
- https://github.com/xgreenx
- https://github.com/PierreOssun
Team LinkedIn Profiles (if available)β
- https://www.linkedin.com/in/mivanichok/
- https://www.linkedin.com/in/ian-arden/
- https://www.linkedin.com/in/hartej/
- https://www.linkedin.com/in/dmitry-kryshtal/
- https://www.linkedin.com/in/valeria-laricheva/
Development Status πβ
The project is already in a solid pre-release state.
PSP - https://github.com/w3f/PSPs/pull/22
Development Roadmap π©β
Overviewβ
We have decided to describe a full roadmap of an Openbrush here, with estimates. However, the funding we request at this stage is only for the second milestone. The first milestone already has been done. Funds for the next milestones will be requested in the next grant.
- Total Estimated Duration: 7 weeks
- Full-Time Equivalent (FTE): 2.5
- Total Costs: 29,999 USD
Current work - Scope of this Grantβ
Milestone 1 - Implement reusable basic contracts in ink!, similar to Openzeppelinβ
- Estimated duration: 2 weeks
- FTE: 2.5
- Costs:
10,000 USD(this cost is covered by Supercolony)
Number | Deliverable | Specification |
---|---|---|
0a. | License | MIT |
0b. | Documentation | We will enhance inline documentation, and create a tutorial on how to import/customize contracts. |
0c. | Testing Guide | We will add unit tests to cover all basic logic and integration tests with Redspot, to verify that all works via contract-pallet |
1a. | Fungible token(Erc20) | We will implement reusable Erc20 analog on ink! |
1b. | Non Fungible token(Erc721) | We will implement reusable Erc721 analog on ink! |
1b. | Multi token(Erc1155) | We will implement reusable Erc1155 analog on ink! |
2a. | AccessControl | We will implement reusable AccessControl analog on ink! |
2b. | Ownable | We will implement reusable Ownable analog on ink! |
Milestone 2 - Simplify usage of library. Add a new features which extend ink!. Provide macroses that will allow creation of your own base implementationβ
- Estimated duration: 7 weeks
- FTE: 2.5
- Costs: 29,999 USD(covered by grant) + 5,000 USD which is covered by Supercolony
Number | Deliverable | Specification |
---|---|---|
0a. | License | MIT |
0b. | Documentation | We will enhance inline documentation, update previous documentation based on simplifications, documentation for new features. |
0c. | Testing Guide | We will test macros, update tests according to new features, simplifications. |
1. | Remove boilerplate code | We will provide a macro which will allow to remove boilerplate during usage of library(Library provides implementation on rust level in internal trait. User must reuse internal implementation with ink! messages. Our macro will simplify it). It will simplify the code structure and usage. |
2. | Derive for storages | We will provide a derive macro to generate implementation for storage's structs. It will simplify integration of fields inside of struct and implementation of storage's traits for that fields. |
3. | Support default implementation in external traits | We will add mnemonic support of default implementations inside of trait definition(traits defined via #[ink::trait_definition] ). It is mnemonic, because under the hood we will generate internal trait with default implementation that will be used in external trait. |
4. | Support of modifiers | We will add support of modifiers, like in Solidity. User will be able to mark some function to use modifiers and it will simplify the code. |
5. | ReentrancyGuard | We will add implementation of ReentrancyGuard |
6. | Implement additional useful contract | We will implement PaymentSplitter, TimelockController and etc. |
Future workβ
Milestone 3. Pre-release - Standardization of tokens contracts. Implement extensions for contracts. Documentationβ
- Estimated Duration: 3 weeks(+ time for PSP approving)
- FTE: 2.5
- Costs: 15,000 USD
Number | Deliverable | Specification |
---|---|---|
0a. | License | MIT |
0b. | Documentation | We will provide inline documentation for macros, create a tutorial on how to use macros in your own project, with a detailed description of how it works inside. |
0c. | Testing Guide | We will add more tests to cover all macros, update tests according to new changes. |
1. | Create Proposal for Fungible token | We will create a proposal for standardization of Erc20 token in case of ink! and contract-pallet . Based on the final decision regarding the proposal update the implementation in library. |
2. | Implement extensions for tokens | We will implement extensions for Erc20, Erc721 and Erc1155 tokens. |
3. | Create Proposal for Non Fungible token and Multi token | We will create proposals for NFT and multi token, when proposal for FT token will be approved. Based on the decisions of these approves, we will update implementation in library. |
Milestone 4. Release - Contribution to inkβ
- Estimated Duration: 4 weeks(time depends on conversations in ink! repository)
- FTE: 2
- Costs: 15,000 USD
Number | Deliverable | Specification |
---|---|---|
0a. | License | MIT |
0b. | Documentation | We will provide inline documentation, example of usage of extensions. |
0c. | Testing Guide | We will add tests for extensions and for a new changes from ink! side. |
1. | Contribute to ink! with fixing of events | We will help to fix the issue with events. |
2. | Add support of default implementation in trait definition on ink! level | We will help with the support of default implementation inside of trait definition. It will require discussions with the ink! team to define the best way how to implement that without conflicts with their future changes. |
3. | Refactor of implementation according changes in ink! | After changes in ink! we will refactor the code of library. |
Milestone 5 - Support of upgradable contractsβ
- Estimated Duration: 7 weeks(time depends on conversations in ink! and
contract-pallet
repositories) - FTE: 2.5
- Costs: 35,000 USD
Number | Deliverable | Specification |
---|---|---|
0a. | License | MIT |
0b. | Documentation | We will provide inline documentation, example of upgradable contracts. |
0c. | Testing Guide | We will add tests to cover upgradability of contracts. |
1. | Implement delegated call | We will find and provide the idea of how delegeted call can be implemented in contract-pallet . Help with it's implementation. |
2. | Help with fallback function | We will help with implementation of fallback function if it is not ready. |
3. | Creation of Proxy contracts | We will provide an alternative of Proxy contracts. |
4. | Documentation and examples | We will add examples and documentation on how the upgradable contract must be implemented. |
Future Plansβ
We're going to make strong impact on the community, making ink! simple and convenient for developers.
- Expertise sharing
- Covering all crypto-related news websites, creating workshops online, handling all relevant forums and social networks
- Becoming an entry point for a developer starting in ink!/Wasm
- Nonstop updating our FAQ and knowledge base, creating educational content (text\video)
- Marketing and PR strategy
- Organizing hackathons, Developing growthhacking strategy for involving developers from different channels
Additional Information ββ
So far we have taken it upon ourselves to fund this project. In the roadmap you can see what was already done, currently we're on the 2-rd milestone.
We havenβt applied for any other grant programs.
How did you hear about the Grants Program? Web3 Foundation Website / Medium / Twitter / Element / Announcement by another team / personal recommendation / etc.
Personal recommendation.