Skip to content
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.

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

[Proposal] Retrieval Tester Utility #1875

Open
supercoolkay opened this issue Mar 5, 2025 · 0 comments
Open

[Proposal] Retrieval Tester Utility #1875

supercoolkay opened this issue Mar 5, 2025 · 0 comments
Assignees

Comments

@supercoolkay
Copy link

Grant Proposal: Retrieval Tester Utility

Project Name: Retrieval Tester Utility
Proposal Category: Retrieval
Individual or Entity Name: Dapps over Apps
Proposer: Dapps over Apps
Project Repo(s):
(Insert repo links here)
Filecoin ecosystem affiliations:
None
(Optional) Technical Sponsor:
N/A
Do you agree to open source all work you do on behalf of this RFP under the MIT/Apache-2 dual-license?:
Yes


1. What is your project and what problem does it solve? (max 100 words)

The Retrieval Tester Utility is a developer tool designed to address the unpredictable and fragmented data retrieval experience on Filecoin. It allows developers to test and benchmark retrieval performance for a given Filecoin content ID (CID) across multiple endpoints and gateways. By providing latency metrics and success rates, the tool helps developers diagnose and optimize their retrieval strategies, ensuring faster and more reliable access to stored data. This contributes to enhancing the overall developer experience and reliability of applications built on Filecoin.


2. How is Filecoin used in this project?

The Retrieval Tester Utility directly interacts with the Filecoin network by querying multiple retrieval endpoints, gateways, and storage providers to fetch data using CIDs. The tool leverages Filecoin’s APIs and public network interfaces to assess on-chain retrieval performance. It gathers metrics such as response times, success rates, and provider availability, thus helping developers optimize data access strategies. By offering a diagnostic layer, it indirectly boosts on-chain activity by encouraging best practices in retrieval, ultimately driving more consistent usage of Filecoin’s retrieval market.


3. How will you improve your project with this grant? What steps will you take to meet this objective?

Number Grant Deliverable Briefly describe how you will meet deliverable objectives Timeframe (within 3 months)
1. Requirement Gathering & Design Engage with the Filecoin developer community to gather detailed requirements and design the utility’s architecture and user interface. Weeks 1-2
2. Development of Core Features Build a CLI-based tool to query multiple retrieval endpoints and compile retrieval metrics (latency, success rate). Weeks 3-6
3. Integration & Testing Integrate with popular Filecoin gateways and perform beta testing with community feedback, ensuring accurate and actionable reporting. Weeks 7-10
4. Documentation & Open Sourcing Create comprehensive documentation, including a recorded demo, and open-source the project on GitHub under MIT/Apache-2 dual-license. Weeks 11-12

4. What is the total amount of this grant request?

$10K


5. Adoption, Reach, and Growth Strategies

The primary target audience is Filecoin developers, especially those building on FVM and reliant on timely and reliable data retrieval. The tool will be promoted through Filecoin developer forums, GitHub, and social media channels (Twitter, Discord). Engagement with developer communities via webinars, blog posts, and GitHub discussions will foster early adoption. As the tool demonstrates value by identifying and helping to resolve retrieval bottlenecks, we expect organic growth among projects that rely on efficient data access, ultimately onboarding more developers and increasing on-chain retrieval activities.


6. If accepted, do you agree to share monthly project updates in this Github Issue until the project described here is complete?

Yes


7. Does your proposal comply with our Community Code of Conduct?

Yes


8. Links and submissions

N/A – This project did not originate from a hackathon but is developed in response to ongoing community needs and feedback.


Additional questions:

Team Members:

  • Project Lead: Abdulkareem Oyeneye
    • Experienced developer, marketer, and project manager with a strong background in the web3 space and expertise in identifying technical needs of protocols.
    • LinkedIn
  • Blockchain Developer & QA Engineer: Emmanuel Charles
    • Experienced in Rust, TypeScript, C++, with a focus on blockchain development and quality assurance.
    • LinkedIn
  • Blockchain Engineer: Musa Abdulkareem
    • Skilled in building robust blockchain toolkits and applications.
    • LinkedIn
  • Full Stack Engineer: Bolaji Ahmad
    • Experienced in building foundational toolkits in the Polkadot ecosystem and other blockchain frameworks.
    • LinkedIn

How did you learn about this grant type program?
We learned about the Filecoin grants program through the Filecoin community channels.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants