# [old] Open Grant Proposal

* **Project Name:** Polkadot's Web3API Implementation
* **Team Name:** Web3API
* **Payment Address:** 0x8fe59d8fb5ffd3509e5cb3d386be8bdb2d363662

## Project Overview :page_facing_up:

We are implementing a Web3API for the Polkadot developer community.

Web3API brings the ease of Web2 to Web3. It aims to make integrating Web3 protocols into applications seamless, without sacrificing decentralization. Interact with any blockchain, from any programming language, in seconds.

> For the visual learners, here is a [video](http://video.web3api.eth.link/).

Web3API accomplishes this through a WebAssembly (WASM) standard and a developer toolchain that streamlines Web3 protocol integrations.
All logic that was once bundled into JavaScript SDKs (among other languages) is now within lightweight, secure, and portable WASM modules called Web3APIs.

Querying these Web3APIs is done through a familiar [GraphQL](https://graphql.org/) interface resulting in a developer experience almost identical to that of a Web2 web service.
Instead of sending GraphQL queries to a centralized endpoint, such as `api.service.com`, apps query a decentralized endpoint like `api.protocol.eth`.

The Web3API Client resolves the Web3API package hosted at its decentralized endpoint, downloads it at runtime (if not present), and executes the application's queries on the WASM modules.

See [the Architecture section](./2_Architecture.md) for a deep dive.

* **How the project relates to / integrates into Substrate / Polkadot / Kusama.**

We'll port the existing [Substrate Javascript SDK](TODO:Link to the specific JS SDK) into a Web3API WASM module.

- **Why your team is interested in creating this project:**

The Web3API DAO has partnered with multiple organizations that are building on Polkadot, and are interested in having a Substrate Web3API available. Additionally, we look forward to collaborate with other developer communities and experts involved in the Polkadot ecosystem.

### Project Details

The benefits to the Polkadot development experience would be:
- **Streamlined Integration** - Query any Web3API on-the-fly, by simply providing its URI (example: `api.protocol.eth`).
- **Simple Interface** - With GraphQL, Web3APIs are as easy to use as Web2 web services.
- **Multi-Platform** - Use Web3 protocols in any programming language by using a Web3API Client.
- **Automatic Updates** - Resolving packages at runtime allows for automatic (opt-in) updates.
- **Limitless Composability** - Since Web3APIs are not bundled, there are no limits to composability.
- **Extendable Protocols** - Web3APIs can query each other and define standard interfaces, enabling fully extendable protocols.

* **Mockups/designs of any UI**:
- [Web3Hub](TODO: Update with latest mockup before submitting application)

* **Data models / API specifications of the core functionality & overview of the technology stack to be used**

- TODO: Create a sample GraphQL API to show them what it might end up looking like: https://github.com/Web3-API/monorepo/issues/128
- [Technical Spec](https://github.com/Web3-API/specification/tree/main/spec)

* **Documentation of core components, protocols, architecture, etc. to be deployed**
- The Substrate Web3API will be written in Assemblyscript, which will them compile to WebAssembly. These WebAssembly modules will be able to run within any Web3API client in any language. The Web3API client is currently implemented in Javascript, with more clients in languages like Rust, Go, and Python to come in the near future. The interface users will be interacting with the API through is GraphQL.

* **PoC/MVP or other relevant prior work or research on the topic**
- [Simple Storage Demo](http://demo.simplestorage.web3api.dev/) : Open With Chrome Desktop Browser *(Full Browser Support Coming Shortly*)
- [EthDenver Demo presentation and walkthrough](https://www.youtube.com/watch?v=9HhB4XL4AR4)

### Ecosystem Fit

* **Where and how does the project fit into the ecosystem?**

Instead of authoring language specific SDKs for application developers to use, authoring a single Web3API can serve as a solution for all developers, regardless of what language they're building in.

* **Are there any other projects similar to yours in the Substrate / Polkadot / Kusama ecosystem?**

No, we're building a novel solution.

## Team :busts_in_silhouette:

### Team members
* Jordan Ellis - Web3API Lead
* Andrew Cassetti - Web3Hub Lead
* Belma Gutlic - Integrations Lead

### Builder Teams
- dOrg: https://dorg.tech
- Concorde: https://concorde.studio
- NodeFactory: https://nodefactory.io/

### Launch Partners
- Gnosis: https://gnosis.io/
- Torus: https://tor.us/
- Wallet Connect: https://walletconnect.org/
- Pocket Network: https://www.pokt.network/
- Fleek: https://fleek.co/
- Abridged: https://abridged.io/
- DXdao: https://dxdao.eth.link/
- Squad Games https://squad.games/
- Rockside: https://rockside.io/
- Mantra DAO: https://mantradao.com
- Razor Network: https://razor.network/
- Aleph: https://aleph.im/
- gelato https://link.comTODO

### Contact
* **Contact Name:** Roberto Henriquez Perozo
* **Contact Email:** [e-mail]
* **Website:** web3api.dev

### Legal Structure
* **Registered Address:** TODO: Address of your registered legal entity, if available. Please keep it in a single line. (e.g. High Street 1, London LK1 234, UK)
* **Registered Legal Entity:** Name of your registered legal entity, if available. (e.g. Duo Ltd.)

### Team's experience

The three developer teams that are currently working on Web3API include high caliber engineers and operation teams which have worked with top-tier protocols like Aragon, Balancer, The Graph, RenVM, WBTC, Vedran, and Gnosis, just to name a few.

#### Previous commits
> If the project involves development work, we would appreciate it if you singled out a few interesting code commits made by team members in past projects.
- [Pre-alpha Monorepo](https://github.com/web3-api/monorepo)
- [Source Code of the Simple Storage Demo](https://github.com/Web3-API/monorepo/tree/prealpha/demos/simple-storage)

### Previous Grants

- **NodeFactory d.o.o.**
- [Vedran](https://github.com/NodeFactoryIo/vedran)
- [Metamask Snap Polkadot](https://github.com/NodeFactoryIo/metamask-snap-polkadot)

### Team Code Repos
* https://github.com/Web3-API

### Team LinkedIn Profiles
* [Jordan Ellis](https://www.linkedin.com/in/jordancellis/)
* [Belma Gutlic](https://www.linkedin.com/in/belmagutlic/)
* [Andrew Cassetti](https://www.linkedin.com/in/andrew-cassetti-33128030/)

## Development Status :open_book:

> If you've already started implementing your project or it is part of a larger repository, please provide a link and a description of the code here. In any case, please provide some documentation on the research and other work you have conducted before applying. This could be:

Additional to the links provided above in the Grant Application, we'd like to

- **Academic publications relevant to the problem**

- [Integration of Blockchains with Management
Information Systems - Chang et. al.](https://eprints.usq.edu.au/38422/)

> TODO: Find one quote & format reference

- [Kadam, S. B., & John, S. K. (2020). Blockchain Integration With Low-Power Internet of Things Devices. Handbook of Research on Blockchain Technology](https://www.sciencedirect.com/science/article/pii/B9780128198162000083)
> *"Practically speaking, most present organizations, looking to deploy blockchain-based applications, **lack the required technical skills and expertise to design and deploy a blockchainbased system and implement smart contracts completely in-house**, that is, without reaching out for vendors of blockchain applications.""*

The two publications above shed a light on the potential usecases of our solution. The Web3API standard along with the Web3Hub platform will help to solve these by abstracting the complex logic and showcasing available protocols for quicker adoption and integration.

- **Links to your research diary, blog posts, articles, forum discussions or open GitHub issues**
- [Substack Newsletter](https://web3api.substack.com/)
- [Monorepo Issues](https://github.com/Web3-API/monorepo/projects/1)
- **References to conversations you might have had related to this project with anyone from the Web3 Foundation**
- Discussed grant viability with Surag from Parity.io on Feb/23/2021
- **Previous interface iterations, such as mock-ups and wireframes.**
- Web3Hub UI/UX
- [First iteration ](https://www.figma.com/proto/NbpargAAWdzNDhvQspv4kF/Web3API---All-Docs?node-id=64%3A955&scaling=min-zoom)
- [Second iteration](https://www.figma.com/proto/INuhC2nI5xXlgxkxs0Qol3/Web3HUB?node-id=277380%3A442&scaling=min-zoom)
- [Third iteration](https://www.figma.com/proto/INuhC2nI5xXlgxkxs0Qol3/Web3HUB?node-id=277594%3A271&viewport=-160%2C83%2C0.1931048482656479&scaling=min-zoom)

## Development Roadmap :nut_and_bolt:

> This section should break the development roadmap down into milestones and deliverables. 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 the project is related to Substrate, Kusama or Polkadot. We _recommend_ that the scope of the work can fit within a three-month period and 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.
To assist you in defining it, we have created a document with examples for some grant categories [here](../src/grant_guidelines_per_category.md).
* 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, and include the approximate number of days along with the cost per day.
* _Deliverables 0a-0d are mandatory_ and shall not be removed, unless you explicitly specify a reason within the PR's `Additional Notes` section (e.g. Milestone X is research oriented and as such there is no code to test).

> :zap: If any of your deliverables is based on somebody else's work, make sure you work and publish _under the terms of the license_ of the respective project and that you **highlight this fact in your milestone documentation** and in the source code if applicable! **Teams that submit others' work without attributing it will be immediately terminated.**

### Overview
* **Total Estimated Duration:** 2 months
* **Full-Time Equivalent (FTE):** 1.00 FTE
* **Total Costs:** $18.000

### Milestone 1 Example — Implement Substrate Modules
* **Estimated Duration:** 1 month
* **FTE:** 1
* **Costs:** 1.000 USD

| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| 0a. | License | Apache 2.0 / MIT / Unlicense |
| 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can (for example) spin up one of our Substrate nodes. Once the node is up, it will be possible to send test transactions that will show how the new functionality works. |
| 0c. | Testing Guide | The code will have unit-test coverage (min. 70%) to ensure functionality and robustness. In the guide we will describe how to run these tests |
| 0d. | Article/Tutorial | We will write an article or tutorial that explains the work done as part of the grant.
| 1. | Substrate module: X | We will create a Substrate module that will... (Please list the functionality that will be coded for the first milestone) |
| 2. | Substrate module: Y | We will create a Substrate module that will... |
| 3. | Substrate module: Z | We will create a Substrate module that will... |
| 4. | Substrate chain | Modules X, Y & Z of our custom chain will interact in such a way... (Please describe the deliverable here as detailed as possible) |
| 5. | Docker | We will provide a dockerfile to demonstrate the full functionality of our chain |

### Milestone 2 Example — Additional features

...

## Future Plans

- **How you intend to use, enhance, promote and support the project in the short term**

- **The team's long-term plans and intentions in conjunction with the project.**

Web3API currently supports a handful of integrations, including ENS, IPFS, Subgraphs, and Ethers.js. With the current release of the Pre-Alpha version, we plan to improve the developer experience and integrate more protocols.

### Today
We’ve just released the Pre-alpha version of the Web3API Client.
We’ve signed on 12 launch partners to be early adopters and help provide feedback, and started the onboarding process
We’ve launched and grown the Web3API DAO to 60+ token holders
We’ve raised a pre-seed round to bring the Client and API Hub to market

### In 3 months:
We’ll release the Alpha version of the Web3API Client and IDE
We’ll release the Substrate API alongside 3-5 launch partner APIs

### In 6 Months:
We’ll release the Pre-alpha version of the Web3Hub, a platform to easily publish, explore, and consume API
Substrate’s Web3API will be integrated into at least 3 applications
We’ll be preparing the first Web3API Hackathon
We’ll have a dozen APIs and dApps using the Web3API standard

### One year from now:
We’ll be the go-to open source dev tool for integrating web3 services.

## Additional Information :heavy_plus_sign:

> Any additional information that you think is relevant to this application that hasn't already been included.

Possible additional information to include:

* Are there are any teams who have already contributed (financially) to the project?
With the objective of funding the initial development of the Web3API core toolchain, in December 2020, the Web3API DAO closed a seed round for 1MUSD from a curated list of strategic individuals. The entire list of funders can be found in the [Web3API DAO repository](https://github.com/Web3-API/dao/blob/master/token-allocations/pre-seed-funders.csv).

* Do you have a community of users or open-source developers who are contributing to the project?
With the launch of the Web3API Pre-Alpha, this year we have started to nurture and expand our opensource developer community in our [Discord](https://discord.gg/Z5m88a5qWu). At the time of writing, the server has 130 members.