Propose Advancing Web3.js Plugin for Polkadot

applications/web3js-plugin-for-polkadot.md

@@ -0,0 +1,143 @@
+# Advancing Web3.js Plugin for Polkadot
+
+Propose to work more on the npm package: [`web3-plugin-polkadot`](https://www.npmjs.com/package/@conx3/web3-plugin-polkadot) and its website www.web3polka.com
+
+- **Team Name:** ConX3
+- **Payment Address:** 11xK5C1XUMsSUSAmguBoHTQLD8EguJCAxaTm1MnjDJ78Vdt (USDC or better in DOT)
+- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 1
+
+## Project Overview :page_facing_up:
+
+### Overview
+
+The npm package: `web3-plugin-polkadot` is a plugin for web3.js to enable communicating with Polkadot, Kusama, and Substrate nodes using web3.js and its development-style. The plugin currently supports calling all RPC methods. This grant request aims to advance the project one step further.
+
+Note: The project was initially developed for the Polkadot Hackathon Winter 2023. You can view its submission here: https://github.com/parity-asia/hackathon-2023-winter/tree/main/projects/32-web3-plugin-polkadot. And it passed the technical filtering with a total of 25 projects. You can find it as the third in the list at [the announcement on X (Twitter)](https://x.com/OneBlock_/status/1739949571525271716?s=20). The final announcement of the winners is yet to be made on the Hackathon's Demo Day on 14 January 2024.
+
+### Project Details
+
+Web3.js Plugin for Polkadot ([`web3-plugin-polkadot`](https://www.npmjs.com/package/@conx3/web3-plugin-polkadot)) currently enables the basic interactions by supporting RPC methods calls. You can check [its details at the npm registry](https://www.npmjs.com/package/@conx3/web3-plugin-polkadot) or at [its repository readme file](https://github.com/conx3/web3-plugin-polkadot). However, it is currently very basic and needs more work to become more useful.
+
+In this grant request, I propose to work on support for subscribing/unsubscribing to blockchain events as the next functionality to be added.
+
+Polkadot, Kusama, and Substrate nodes provide subscription in a way that differs from Ethereum, which has only 2 endpoints for all subscriptions: `'eth_subscribe'` and `'eth_unsubscribe'`. Therefore, the proposal is to work on inheriting and modifying the `SubscriptionManager` that is developed by web3.js so it handles subscription using the methods:
+
+```
+'beefy_subscribeJustifications',
+'beefy_unsubscribeJustifications',
+'chain_subscribeAllHeads',
+'chain_subscribeFinalisedHeads',
+'chain_subscribeFinalizedHeads',
+'chain_subscribeNewHead',
+'chain_subscribeNewHeads',
+'chain_subscribeRuntimeVersion',
+'chain_unsubscribeAllHeads',
+'chain_unsubscribeFinalisedHeads',
+'chain_unsubscribeFinalizedHeads',
+'chain_unsubscribeNewHead',
+'chain_unsubscribeNewHeads',
+'chain_unsubscribeRuntimeVersion',
+'grandpa_subscribeJustifications',
+'grandpa_unsubscribeJustifications',
+'state_subscribeRuntimeVersion',
+'state_subscribeStorage',
+'subscribe_newHead',
+'unsubscribe_newHead',
+```
+
+### Ecosystem Fit
+
+The target audience of this package are JavaScript and TypeScript developers creating tools or dApps for Polkadot, Kusama, and Substrate. There are 3 key benefits to this:
+
+#### Development Experience and Learning Curve
+Developers already familiar with web3.js would be able to quickly start communicating with Polkadot and Substrate nodes with fewer new concepts to learn. All they need to do is link web3.js with a Polkadot, Kusama, or Substrate provider, register the plugin, and start working as usual with slight adjustments.
+
+#### Code Portability
+Existing Ethereum DApp code using web3.js could be adapted with relative ease to work with Polkadot and Substrate. Only a few changes to current code would be needed. This means developers may use the same codebase for interacting with both Ethereum-based nodes and Substrate nodes, with some custom handling.
+
+#### Diversity
+Providing developers with an additional alternative to `@polkadot/api` is beneficial. This way, developers can choose which library they feel more comfortable working with.
+
+
+
+## Team :busts_in_silhouette:
+
+### Team members
+
+- Muhammad Altabba, Blockchain Tools Developer
+
+### Contact
+
+- **Contact Name:** Muhammad Altabba
+- **Contact Email:** [email protected]
+- **Website:** http://www.conx3.com/ (under construction)
+
+### Legal Structure
+
+Applying as an individual.
+
+### Team's experience
+
+Muhammad Altabba has nearly 15 years experience in software development and the last 5+ years was in the blockchain and decentralized identity space. And is currently working with the team developing and maintaining web3.js.
+
+### Team Code Repos
+
+Project repo: 
+- https://github.com/conx3/web3-plugin-polkadot
+
+GitHub account: 
+- https://github.com/Muhammad-Altabba
+
+### Team LinkedIn Profiles
+
+- https://linkedin.com/in/muhammadaltabba
+
+
+## Development Status :open_book:
+
+The initial version of the library has been developed during Polkadot Hackathon 2023 Winter in Hong Kong. And the following are already available:
+- A full functional web3.js plugin that provides access to all RPC methods in the web3.js style.
+- Limit the RPC methods to what is available at Polkadot, Kusama and Substrate, out-of-the-box.
+- Developers can provide their list and the types specifications of the supported RPC methods for any variant network, or customized node, and they will have the IntelliSense accordingly.
+- Tests with 100% coverage.
+- The npm package has been published up to [version 0.0.2 at the npm registry](https://www.npmjs.com/package/@conx3/web3-plugin-polkadot/v/0.0.2?activeTab=versions).
+- A basic documentation has been provided in the readme file.
+
+
+## Development Roadmap :nut_and_bolt:
+
+### Overview
+
+- **Total Estimated Duration:** 1 month
+- **Full-Time Equivalent (FTE):** 0.20
+- **Total Costs:** 2,000 USD
+
+### Milestone 1 (out of 1) — Support Subscribing/Unsubscribing to blockchain events
+
+- **Estimated duration:** 1 month
+- **FTE:** 0.20
+- **Costs:** 2,000 USD
+
+| Number | Deliverable | Specification |
+| -----: | ----------- | ------------- |
+| **0a.** | License | MIT |
+| **0b.** | Documentation | Provide both **inline documentation** of the code and a basic **tutorial**, and possibly a video, that explains how a user can use the plugin to subscribe/unsubscribe to events. |
+| **0c.** | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. |
+| **0d.** | Docker | Provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
+| 0e. | Article | Publish an **article** that explains what had been im implemented in this grant featuring the use of subscriptions. |
+| 1. | Support subscribe/unsubscribe | Polkadot, Kusama and Substrate nodes provide subscription in a way the differs a bit from Ethereum that has only 2 endpoints for all subscriptions: `'eth_subscribe'` and `'eth_unsubscribe'`. For that, work on inheriting and modifying the `SubscriptionManager` developed by web3.js to handle subscription using the RPC methods available on Polkadot, Kusama and Substrate nodes |
+
+## Future Plans
+
+- Implement additional functionalities, such as accounts handling and smart contract interactions. There will be subsequent grant requests for these and other functionalities.
+- Work on the complementary stuff like the plugin identity design and website content, the CD/CI integration in GitHub and an in-browser playground...
+- Popularize the library through tutorials, illustrative videos, workshops, and sponsoring bounties at hackathons.
+- Develop more plugins for the Polkadot ecosystem.
+
+This project will rely on grants and sponsorships as it serves the entire ecosystem and its decentralized vision. There will be further grant requests, starting with this initial modest application to familiarize ourselves with the processes.
+
+For the related plugin and libraries, additional applications for grants and sponsorships to the various Substrate networks and beneficiaries, for each different plugin serving different parts of the ecosystem, will be considered.
+
+## Additional Information :heavy_plus_sign:
+
+**How did you hear about the Grants Program?** Web3 Foundation Website and Raul Ritti at Element.