- Project Name: OpenBrush
- Team Name: 727.ventures
- Payment Address: ERC 20 (DAI): 0x352F779203202c99699CdA8cc95adF06CcC8abEf
- Level: 3, It is follow-up grant for first grant and for second grant.
Project Overview 📄
It is an application for a follow-up grant. The initial grant covered the first and second milestones:
The second grant covered the 3-5 milestones:
- Openbrush Milestone 3 delivery report
- Openbrush Milestone 4 delivery report
- Openbrush Milestone 5 delivery report
This grant aims to cover milestones 6-7.
The mission of this project is to make ink! usable and facilitate WASM ecosystem adoption.
To be successful with this mission, we have outlined several steps that would need to be taken.
- OpenBrush is a library for secure smart contract development on ink!, same as OpenZeppelin on Ethereum.
- 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.
- For Openbrush to fulfill its purpose, several changes must be made & several blockers to be overcome in
ink!and in Substrate's
pallet-contracts. We are committed to doing 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 considerable part of it.
OpenBrush should serve as a starting point for every smart contract developer coming from Ethereum. The extended documentation will cover several topics: the differences between ink! and Solidity, how developers should change their mindset, how to design their project, how to deploy contracts 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 useful for development that are not available in ink! yet(the plan is to integrate them to ink! itself at a later point within Openbrush scope), 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.
- 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 quickly realized that we strategically would like to become the company that builds in the ecosystem. We decided that we wanted to commit and help ink! become widely used. Right now usability of ink! can be easily improved. 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 is 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 common 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 continue doing so)
- OpenBrush aims to be a starting point for any smart contract developer by providing documentation.
- Contribute to ink! and Substrate
contract-palletto improve the smart-contract development experience(add new features, fix bugs, etc.).
Markian Ivanichok (CEO | 727.ventures)
Fedor Lebed (Head of Operations | 727.ventures)
Green Baneling (Blockchain Core Rust Engineer | 727.ventures)
Dominik Krížo (Head of Engineering | 727.ventures) Varex Silver (Blockchain developer | 727.ventures) Artem Lech (Blockchain developer | 727.ventures) Nameless Endless (Blockchain developer | 727.ventures) Maria Nevska (Marketing specialist | 727.ventures)
- Registered Address: The registered office shall be in Coastal Building, Wickham’s Cay II, P. O. Box 2221, Road Town, Tortola, VG1110, British Virgin Islands.
- Registered Legal Entity: Seven2seven Ventures Ltd
CEO of 727.ventures, Blockchain entrepreneur, Software Engineer. Started my engineering career back when I was 15. Since then, I developed and got a lot of experience in engineering 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 entrepreneurs to move faster.
Head of Operations Fedor is the head of operations at Brushfam, a portfolio company of 727. ventures which is developing the ink! Smart contracts tools. Fedor invested in mining pools from 15 years old. He has a background in product management, working with international software products for Tier-1 markets.
Rust Blockchain Core Developer
Primary programming languages are: C++, Go, Rust Finished the faculty of applied mathematics(Master 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).
Head of Engineering Started programming own games at age of 15 as a hobby, then went to University studying informatics and object oriented programming, becoming an Android developer in 2018. In 2017 he started his crypto venture by investing in BTC and Ethereum and getting more knowledge regarding smart contracts and DeFi protocols during DeFi summer 2020. As a programmer, he wanted to know more behind the scenes of smart contracts, so he started to develop his own smart contract applications for Ethereum and then becoming a Rust and Ink! developer in , since he believes that WASM with its benefits over EVM is the future of smart contract applications.
Student of Computer Science at the Kyiv National University of Taras Shevchenko. Participated in programming competitions of different stages in school since 2017 (C++). Was a Backend developer(Go), Solidity developer(Solidity, Hardhat, Typescript), and now Blockchain developer(Rust, Typescript).
Student of Applied Mathematics at the Kyiv National University of Taras Shevchenko. Started programming in 2016 and participated in a lot of Ukrainian and international competitions of competitive programming. Worked as a lecturer of algorithms at the school of competitive programming and as Intern Backend Engineer (Rust). Now works as Blockchain Developer on Polkadot Blockchain (Rust, Typescript).
Became interested in programming at the age of 16. At this time, he tried web development and created a website. Then decided to go to University to study system programming and object-oriented programming. Most often, he used C and C++ languages. Nameless likes innovations of web3 technologies and believes in the potential of Rust language and WASM standard for smart contracts.
Marketing specialist PR&Marketing specialist with global brands work experience since 2018. Master degree Business Economics. Has worked with global international beauty brands: Lancôme, Biotherm, Yves Saint Laurent, Kerastase, Valentino Beauty for 3 years. Blockchain PR&Marketing since 2021.
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.
Team LinkedIn Profiles (if available)
Development Status 📖
The project is already in release
Development Roadmap 🔩
We have decided to describe a full roadmap of an OpenBrush here, with estimates. However, the funding we request at this stage is for milestones 6-7.
- Total Estimated Duration: 13 weeks
- Full-Time Equivalent (FTE): 3
- Total Costs: 99 999 USD
Milestone 1 - Implement reusable basic contracts in ink!, similar to Openzeppelin
- Estimated duration: 2 weeks
- FTE: 2.5
10,000 USD(this cost is covered by Supercolony)
- Delivery status: Delivered
|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 |
|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
- Delivery status: Delivered
|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 |
|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.|
Milestone 3. Reduce the size of Erc20 contract
- Estimated Duration: 4 weeks
- FTE: 1.5
- Costs: 12,000 USD
- Delivery status: Delivered
|0b.||Documentation||We will provide a report of how much each optimization reduced the size.|
|1.||Reduce the size of Erc20 contract||Now the most critical moment with ink! is the huge size of contracts. This issue described the problem very well. The parity team works in this direction, and we want to help with ink! side. The ink! team created issue 906, 916 and 910. We want to briefly(not full change, only minimal changes to reduce the size) implement them and provide a report(re-working data structure, reducing monomorphization, using dynamic dispatch in some cases). Based on this report, the ink! team can decide how better to implement them and which part is more critical. During the implementation, we will build examples with our version of ink! (also maybe we will modify some sub-crates). So the output of this work is a report and custom version of ink!. The code can be reused, or if ink! team agrees we can try to implement these issues by ourselves later as separate work.|
Milestone 4. Pre-release - Standardization of tokens contracts. Implement extensions for contracts. Documentation
- Estimated Duration: 4.5 weeks(+ time for PSP approving)
- FTE: 2.5
- Costs: 22,500 USD
- Delivery status: Delivered
|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 |
|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.|
|4.||Use original ink! instead of our own||We will use ink! |
|5.||Refactor the contracts to be compatible with PSPs||We will refactor the contracts according to the PSP.|
|6.||Refactor the structure of the OpenBrush to provide agnostic traits||We will refactor the structure of the OpenBrush to provide traits for each implementation of the contract without restriction and implementation related information:|
- Traits will be defined in a separate module.
- The default implementation of that trait for a contract will be provided via unstable feature
- We will provide a new macro to generate a wrapper around a trait. That wrapper can be used for cross-contract calls. So the user is enough of the trait definition to do a cross contract call.
Milestone 5. Release - Contribution to ink
- Estimated Duration: 4 weeks(time depends on conversations in ink! repository)
- FTE: 2
- Costs: 15,000 USD
|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.||Re-work the storage of contracts||We want to resolve the issue.|
|3.||Refactor of implementation according changes in ink!||After changes in ink! we will refactor the code of library.|
Current work - Scope of this Grant
Milestone 6. Upgradable contracts
- Estimated Duration: 6 weeks
- FTE: 3
- Costs: 50 000 USD
|0b.||Documentation||We will provide a documentation of how to write upgradable contracts|
|1.||Implement ||The ethereum has a |
|2.||Implement ||The usage of |
|3.||Import ||Support of |
|4.||Implement Diamond Standard in OpenBrush with ink!||We will provide the implementation of the Diamond standard in OprnBrush. Anyone can easily reuse the implementation or use traits to interact with contracts.|
|5.||Implement Diamond Standard on raw Rust without ink!||Right now the ink! adds a lot of overhead and increases the size of the contract. Implementation of the Diamond standard with raw rust will show the overhead impact and will provide an additional example for WASM developers on how to write contracts without ink!.|
|6.||Create an upgradable analog of each contract in OpenBursh||OpenBrush provides many implementations of different contracts. With upgradability, we also need to provide an upgradable version of each contract.|
|7a.||Marketing - Write down article about OpenBrush||We are going to write the article abot the importance of OpenBrush and applied usage of it. Moreover, 727.ventures team will promote it in Twitter, Medium etc.|
|7b.||Marketing - Create 2 educational video for OpenBrush||We are going to work on educational video materials for OpenBrush and ink! Community. We see a huge gap in knowledge, understanding, and vision for the whole community in that sphere. Moreover, 727.ventures team will promote it in Twitter, Medium etc. We will create a lower entry threshold for newcomers by this educational program.|
Milestone 7. AssetPallet chains extension
- Estimated Duration: 8 weeks
- FTE: 2.5
- Costs: 57 000 USD
|0b.||Documentation||We will provide a report of how to transition from PSP22 on contract level to PSP22 on pallet level. Add documentation about the workflow of PSP22 and Statemint parachain.|
|1.||Implement ||We will implement a chain extension on the |
|2.||Implement ||Usage of chain extension requires implementation on the level of the contract too, so we will implement it in OpenBrush. Anyone will be able to reuse chain extension.|
|3.||Implement PSP22 with that chain extension in OpenBrush||The OpenBrush will provide a default implementation for |
|4.||Create standards for ||The |
|5.||Advanced ink! unit testing framework||Add support to the contract deployment, chain extension registration, and smart contract cross-contract calls into the ink! unit test framework.|
|6.||Support of XCM and cross transferring of ||If the support of XCM by the |
|7.||Add support for ink! 4.0||We will update OpenBrush to be compatible with ink! 4.0 releases|
|8a.||Marketing - Create 2 educational video for OpenBrush/ink!||We are going to work on educational video materials for OpenBrush and ink! Community. We see a huge gap in knowledge, understanding, and vision for the whole community in that sphere. Moreover, 727.ventures team will promote it in Twitter, Medium etc. We will create a lower entry threshold for newcomers by this educational program.|
|8b.||Marketing - The website upgrade||We are going to update out current website and add more specific things to improve the search for OpenBrush website in Google.|
RMRKPallet chain extension
- Estimated Duration: 8 weeks
- FTE: 2.5
- Costs: 55 300 USD
|0b.||Documentation||We will provide a report regarding size reductions. We will create documentation and standards to describe the workflow of Non-Fungible token chain extension, how to reuse it and how it works.|
|1.||Create PSP for NFT on RMRK||We plan to create a new standard for NFT tokens based on RMRK. We will work with the RMRK team on the finalization of the standard. We will try to be compatible with |
|2.||Implement chain extension for NFT on substrate level||In the same way as for the |
|3.||Implement chains extension in OpenBrush||Implementation of contract versions of the |
|4.||Implement NFT contract via chain extensions||OpenBrush will provide a default implementation of contracts that are implemented via according chains extensions.|
|5.||Refactoring of trait system in the ink!||Refactoring of trait system in the ink! to support default implementation inside of traits. It should improve the developer's experience with traits and simplify its usage.|
|6.||Marketing - Create 4 educational video for OpenBrush/ink!||We are going to work on educational video materials for OpenBrush and ink! Community. We see a huge gap in knowledge, understanding, and vision for the whole community in that sphere. Moreover, 727.ventures team will promote it in Twitter, Medium etc. We will create a lower entry threshold for newcomers by this educational program.|
|7.||ink! storage docs||There is no documentation with clear description of how the storage works within ink!. As our team was the one doing the refactoring of ink! storage, we will create a comprehensive documentation on how the storage works in ink! 4, as well as detailed comparison on what was changed in comparison to ink! 3 storage, including examples of usage.|
Milestone 9. Multi token chain extension
- Estimated Duration: 4 weeks
- FTE: 2.5
- Costs: 30 000 USD
|0b.||Documentation||We will provide a report regarding size reductions. We will create documentation and standards to describe the workflow of Multi token chain extension, how to reuse it and how it works.|
|1.||Implement chain extension for Multi token in substrate level||In the same way as for the |
|2.||Implement chains extension in OpenBrush||Implementation of contract versions of the |
|3.||Implement multi token contracts via chain extensions||OpenBrush will provide a default implementation of contracts that are implemented via according chain extension.|
|4.||Reduce the size of the contracts more(investigation and implementation)||After the support of main chain extensions, we plan to focus on the contract size reduction of all contracts in OpenBrush. We plan to contribute to ink! and participate in according issue.|
|5.||Advanced documentation||For the better understanding, we will post on the OpenBrush website - the clear technical checklist to become an ink!/OpenBrush engineer. It will attract more developers and builders in the ecosystem|
NOTES: During each milestone, we also will maintain OpenBrush to be compatible with a new version of ink! and contract-pallet:
- Update of the code
- Bug reporting and maybe help with resolving of bugs
- Suggest/help with new features
- Actualizing of the OpenBrush documentation
- Analyzing the code to report ideas regarding size-reduction
- Help to evolve community: answer questions, share knowledge.
After, this Grant, we will create a grant related to upgradable contracts.
We're going to make a strong impact in 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 growth hacking strategy for involving developers from different channels
Additional Information ➕
In the roadmap, you can see what was already done. Currently, we're on the 5th milestone. The 5th milestone depends on review from ink! team so we started 6th milestone in parallel.
We`re organising the first WASM conference in the whole Polkadot ecosystem. This event is a part of Open Brush marketing strategy.
How did you hear about the Grants Program? Web3 Foundation Website / Medium / Twitter / Element / Announcement by another team / personal recommendation / etc.