Skip to content

Fix markdown format to align with template #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
szg251 merged 2 commits into from
Nov 19, 2025
Merged

Fix markdown format to align with template #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
083cd9e
Fix markdown format to align with template
szg251 Nov 19, 2025
1fd0b6c
Clarify license
szg251 Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
245 changes: 49 additions & 196 deletions submarine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Submarine — Open Explorer & Indexer for Polkadot

> [!NOTE]
> This document will be part of the terms and conditions of your agreement and, therefore, needs to contain all the required information about the project. Don't remove any of the mandatory parts presented in bold letters or as headlines (except for the title)! Lines starting with a `>` (such as this one) should be removed. Please use markdown instead of HTML (e.g., `![](image.png)` instead of `<img>`).
>
> See the [Grants Program Process](https://grants.web3.foundation/docs/process) on how to submit a proposal.




- **Team Name:** MLabs LTD
- **Payment Details:**
- **DOT**: For the **DOT** compensation, please provide a Polkadot address (e.g. 15oF4...).
Expand Down Expand Up @@ -110,12 +102,6 @@ Unlike existing explorer offerings that are tightly coupled to specific hosting

## Team


> [!IMPORTANT]
> Please note that the data provided in this section is for administrative and informational purposes only. All beneficiaries of a grant must also be listed in the KYC/KYB process during the application phase. See our [FAQ](https://grants.web3.foundation/docs/faq#what-is-kyckyb-and-why-do-i-have-to-provide-this-data) for more info.



### Team members

- Luke Mahoney
Expand Down Expand Up @@ -195,16 +181,6 @@ NA

## Development Status

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:

- links to improvement proposals or [RFPs](https://grants.web3.foundation/docs/rfps) (requests for proposal),
- academic publications relevant to the problem,
- links to your research diary, blog posts, articles, forum discussions or open GitHub issues,
- references to conversations you might have had related to this project with anyone from the Web3 Foundation,
- previous interface iterations, such as mock-ups and wireframes.



We have completed initial research and a working Rust prototype that validate feasibility and performance assumptions for Submarine. The materials below underpin the project’s viability. Please request access from the MLabs team:

Executive summary:
Expand All @@ -221,13 +197,6 @@ This section should break the development roadmap down into milestones and deliv
Below we provide an **example roadmap**. In the descriptions, it should be clear how your project is related to Substrate, Kusama or Polkadot. We *recommend* that teams structure their roadmap as 1 milestone ≈ 1 month.



> [!CAUTION]
> If any of your deliverables are 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! **Projects that submit other people's work without proper attribution will be immediately terminated.**




### Overview


Expand All @@ -251,34 +220,15 @@ Below we provide an **example roadmap**. In the descriptions, it should be clear
$29,760


> [!NOTE]
> **The default deliverables 0a-0d below are mandatory for all milestones**, and deliverable 0e at least for the last one.


Number
Deliverable
Specification
0a
License
Apache 2.0 / GPLv3 / MIT / Unlicense. See the delivery guidelines for details.
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 and send test transactions, which will show how the new functionality works. See the delivery guidelines for details.
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. See the delivery guidelines for details.
0d
Docker
We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone.
1
SCALE Parser
Build a parser that consumes raw SCALE-encoded bytes and, using on-chain metadata, splits them into pallet-call indices and parameter payloads.
2
Metadata Fetching & Caching
Auto-fetch latest on-chain metadata; Cache metadata versions based upon changes signified by specVersion or txVersionbumps.
3
Type Registry Generation
Tooling to generate and version per-chain custom type registries; persist registries for historical lookups and re-decode.
| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **0a.** | License | Apache 2.0 |
| **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 and send test transactions, which will show how the new functionality works. |
| **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 | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 1. | SCALE Parser | Build a parser that consumes raw SCALE-encoded bytes and, using on-chain metadata, splits them into pallet-call indices and parameter payloads. |
| 2. | Metadata Fetching & Caching | Auto-fetch latest on-chain metadata; Cache metadata versions based upon changes signified by specVersion or txVersion bumps. |
| 3. | Type Registry Generation | Tooling to generate and version per-chain custom type registries; persist registries for historical lookups and re-decode. |



Expand All @@ -296,45 +246,18 @@ Tooling to generate and version per-chain custom type registries; persist regist
$48,852


> [!NOTE]
> **The default deliverables 0a-0d below are mandatory for all milestones**, and deliverable 0e at least for the last one.




Number
Deliverable
Specification
0a
License
Apache 2.0 / GPLv3 / MIT / Unlicense. See the delivery guidelines for details.
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 and send test transactions, which will show how the new functionality works. See the delivery guidelines for details.
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. See the delivery guidelines for details.
0d
Docker
We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone.
1
Research
Research and develop of data structures and parsers needed for Relay + AssetHub - Basic smoke testing
2
Block scanner with basic checkpointing
Continuously pull new blocks via RPC, decode extrinsics/events (using the M1 parser), and persist a “last processed block” pointer.
3
Rewind
On restart or re-org, rewind N blocks based upon point (e.g. 5–10) to ensure consistency
4
Field extraction & Filtering
Prioritize field selection for UI pertinent information such as account ID balances, transfer records (`from` , `to` , `amount` , `block` , etc); Discard non-prioritized information
5
Storage Schema Design & Implementation
Define a DB schema for storing and accessing the extracted information; implement database queries
6
Data-Access Module
Define and design required endpoints; API exposing in-process function calls that batch, group, and sort results for UI consumption
| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **0a.** | License | Apache 2.0 |
| **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 and send test transactions, which will show how the new functionality works. |
| **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 | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 1. | Research | Research and develop of data structures and parsers needed for Relay + AssetHub - Basic smoke testing |
| 2. | Block scanner with basic checkpointing | Continuously pull new blocks via RPC, decode extrinsics/events (using the M1 parser), and persist a "last processed block" pointer. |
| 3. | Rewind | On restart or re-org, rewind N blocks based upon point (e.g. 5–10) to ensure consistency |
| 4. | Field extraction & Filtering | Prioritize field selection for UI pertinent information such as account ID balances, transfer records (`from` , `to` , `amount` , `block` , etc); Discard non-prioritized information |
| 5. | Storage Schema Design & Implementation | Define a DB schema for storing and accessing the extracted information; implement database queries |
| 6. | Data-Access Module | Define and design required endpoints; API exposing in-process function calls that batch, group, and sort results for UI consumption |



Expand All @@ -351,35 +274,15 @@ Define and design required endpoints; API exposing in-process function calls tha
$25,830


> [!NOTE]
> **The default deliverables 0a-0d below are mandatory for all milestones**, and deliverable 0e at least for the last one.



Number
Deliverable
Specification
0a
License
Apache 2.0 / GPLv3 / MIT / Unlicense. See the delivery guidelines for details.
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 and send test transactions, which will show how the new functionality works. See the delivery guidelines for details.
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. See the delivery guidelines for details.
0d
Docker
We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone.
1
Component Development
Draft wireframes and build out front-end screens; Implement Navigation and routing between views; Loading, empty-state, error, etc displays
2
Data-access Integration
Wire up in-process function calls to UI components; Ensure pagination and filter controls map cleanly
3
Essential Validation & Testing
End-to-end smoke tests: block →decode → store → UI render; Verify UX flows
| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **0a.** | License | Apache 2.0 |
| **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 and send test transactions, which will show how the new functionality works. |
| **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 | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 1. | Component Development | Draft wireframes and build out front-end screens; Implement Navigation and routing between views; Loading, empty-state, error, etc displays |
| 2. | Data-access Integration | Wire up in-process function calls to UI components; Ensure pagination and filter controls map cleanly |
| 3. | Essential Validation & Testing | End-to-end smoke tests: block →decode → store → UI render; Verify UX flows |


### Milestone 4 — Infrastructure & DevOps
Expand All @@ -394,35 +297,15 @@ End-to-end smoke tests: block →decode → store → UI render; Verify UX flows
$18,648


> [!NOTE]
> **The default deliverables 0a-0d below are mandatory for all milestones**, and deliverable 0e at least for the last one.



Number
Deliverable
Specification
0a
License
Apache 2.0 / GPLv3 / MIT / Unlicense. See the delivery guidelines for details.
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 and send test transactions, which will show how the new functionality works. See the delivery guidelines for details.
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. See the delivery guidelines for details.
0d
Docker
We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone.
1
Containerization
Dockerize each component (decoder, indexer, UI); Define reproducible images with clear version tags
2
CI/CD Pipeline
Automate builds, unit/integration tests
3
Hosting & Deployment
Stand up bare-metal infrastructure; Configure load-balancers, db clusters, and network security; Monitoring and logging implementation; Manage secrets and environment-specific configs
| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **0a.** | License | Apache 2.0 |
| **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 and send test transactions, which will show how the new functionality works. |
| **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 | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 1. | Containerization | Dockerize each component (decoder, indexer, UI); Define reproducible images with clear version tags |
| 2. | CI/CD Pipeline | Automate builds, unit/integration tests |
| 3. | Hosting & Deployment | Stand up bare-metal infrastructure; Configure load-balancers, db clusters, and network security; Monitoring and logging implementation; Manage secrets and environment-specific configs |



Expand All @@ -438,37 +321,15 @@ Stand up bare-metal infrastructure; Configure load-balancers, db clusters, and n
$42,948


> [!NOTE]
> **The default deliverables 0a-0d below are mandatory for all milestones**, and deliverable 0e at least for the last one.



Number
Deliverable
Specification
0a
License
Apache 2.0 / GPLv3 / MIT / Unlicense. See the delivery guidelines for details.
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 and send test transactions, which will show how the new functionality works. See the delivery guidelines for details.
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. See the delivery guidelines for details.
0d
Docker
We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone.
1
Partner Parachain Onboarding
Identify 2-5 partner parachains and secure agreement for 6-month free trial; Organize customized integration relative their parachain specifics
2
Essential Validation
Ensure explorers are operating properly relative chain specific types and metadata; Verify critical workflows versus actual on-chain activity
3
Service Deployment, Monitoring and Feedback loop
Deploy integrated indexers to our infrastructure; Collect partner chain and, where available, community feedback; BD efforts for further product development including organizing further community funding if necessary


| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **0a.** | License | Apache 2.0 |
| **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 and send test transactions, which will show how the new functionality works. |
| **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 | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 1. | Partner Parachain Onboarding | Identify 2-5 partner parachains and secure agreement for 6-month free trial; Organize customized integration relative their parachain specifics |
| 2. | Essential Validation | Ensure explorers are operating properly relative chain specific types and metadata; Verify critical workflows versus actual on-chain activity |
| 3. | Service Deployment, Monitoring and Feedback loop | Deploy integrated indexers to our infrastructure; Collect partner chain and, where available, community feedback; BD efforts for further product development including organizing further community funding if necessary |


## Future Plans
Expand All @@ -482,7 +343,7 @@ Please include here

In the near term, our focus is exactly what this grant proposes: harden the Rust indexer and explorer, finalize the versioned relational schema, and ship a documented REST API with an OpenAPI spec and cursor-based pagination. We’ll cut tagged releases, provide a reference deployment (Docker on bare metal or common IaaS), and validate end-to-end on 2–5 pilot parachains so that fresh deployments ingest blocks, decode extrinsics/events, and render in the UI reliably. This phase is about turning the current prototype into a stable, reproducible open-source baseline that any team can self-host.

Beyond the grant, we intend to build a sustainable business around Submarine while keeping the core Apache-2.0/MIT and vendor-neutral. Ongoing development and maintenance will be financed through optional managed hosting with transparent, usage-based pricing; support subscriptions with SLAs and onboarding; and funded integrations for chain-specific extractors or new pallets. This model preserves zero lock-in—teams can run Submarine themselves, or pay for convenience and guarantees—while giving us a durable path to maintain compatibility across runtime upgrades, publish benchmarks and cost profiles, and keep the roadmap public and semantically versioned.
Beyond the grant, we intend to build a sustainable business around Submarine while keeping the core Apache-2.0 and vendor-neutral. Ongoing development and maintenance will be financed through optional managed hosting with transparent, usage-based pricing; support subscriptions with SLAs and onboarding; and funded integrations for chain-specific extractors or new pallets. This model preserves zero lock-in—teams can run Submarine themselves, or pay for convenience and guarantees—while giving us a durable path to maintain compatibility across runtime upgrades, publish benchmarks and cost profiles, and keep the roadmap public and semantically versioned.


## Additional Information
Expand All @@ -495,11 +356,3 @@ Here you can also add any additional information that you think is relevant to t
- Work you have already done.
- If there are any other teams who have already contributed (financially) to the project.
- Previous grants you may have applied for.