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

Create Polkanalysis.md #2430

Merged
merged 3 commits into from
Nov 27, 2024
Merged

Create Polkanalysis.md #2430

merged 3 commits into from
Nov 27, 2024

Conversation

Apolixit
Copy link
Contributor

Project Abstract

Polkanalysis is a Substrate-based blockchain explorer.
It’s a web application and an API that combines data directly retrieved from the chain with a background service that also performs on-chain queries to populate a database.

Grant level

  • Level 1: Up to $10,000, 2 approvals
  • Level 2: Up to $30,000, 3 approvals
  • Level 3: Unlimited, 5 approvals (for >$100k: Web3 Foundation Council approval)

Application Checklist

  • The application template has been copied and aptly renamed (project_name.md).
  • I have read the application guidelines.
  • Payment details have been provided (Polkadot AssetHub (USDC & DOT) address in the application and bank details via email, if applicable).
  • I understand that an agreed upon percentage of each milestone will be paid in vested DOT, to the Polkadot address listed in the application.
  • I am aware that, in order to receive a grant, I (and the entity I represent) have to successfully complete a KYC/KYB check.
  • The software delivered for this grant will be released under an open-source license specified in the application.
  • The initial PR contains only one commit (squash and force-push if needed).
  • The grant will only be announced once the first milestone has been accepted (see the announcement guidelines).
  • I prefer the discussion of this application to take place in a private Element/Matrix channel. My username is: @_______:matrix.org (change the homeserver if you use a different one)

@github-actions github-actions bot added the admin-review This application requires a review from an admin. label Oct 20, 2024
Copy link
Contributor

github-actions bot commented Oct 20, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@Apolixit
Copy link
Contributor Author

I have read and hereby sign the Contributor License Agreement.

Copy link
Member

@semuelle semuelle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Apolixit, thank you for the application. I'm impressed with the work you have already put into the project and appreciate that you are moving the .NET tools forward. Two issues:

  1. We don't usually fund work retroactively. At the same time, we don't want to punish people who work on projects in their own time. If you could clarify how much time you are still planning to put into the project before submitting the milestone, it could help us better understand where you are in the process. Also, it would help with the decision if the application was more focused on the remaining part.
  2. We have funded a number of explorers and related tools, and almost all of them fail to get a sufficient number of paying customers to keep up operations. If you are - at least initially - not planning to compete with the major explorers, how are you planning to get there?

Lastly, the deliverables listed under 9 are currently published under GPL. The milestone spec lists MIT as the license, so unless you are planning to change the license, I suggest that you remove them. Feel free to list them separately under "Additional Work" or a similar heading.

@semuelle semuelle self-assigned this Oct 22, 2024
@Apolixit
Copy link
Contributor Author

Hello @semuelle ,
Thank you very much for your feedback!

Here are the answers to your different points:

For the 9 points mentioned in Milestone 1, the only one that hasn’t been fully developed is the web application (I’ve started it, but let’s say it’s at 50%). The other elements are either completely developed or around 80%. At this point, I can, if you like, add a progress status for each of them.
Nevertheless, I still have around 3 months of development and testing left to stabilize the application. To give you some examples, I still have a few bugs related to CheckMetadaHash and the generation of enums in C# (I noticed that some enums have the same index). I also need to develop several front-end components.
In summary:
I’m at 50% for the web application (3 weeks of work remaining)
I still need to stabilize my infrastructure, as I’m having a few issues mapping my data (1 month)
A few bugs related to the database and concurrent calls since everything is asynchronous (1 week)
Deploy everything in production and start populate the production database (2 weeks)

I will update the PR with the progress percentages for everything.

Regarding the second point, I plan to:

  • See how much the cloud database would cost
  • If cloud is too expensive, choose a data center and set up my own server (expensive to buy, but after that, the costs are fully controlled)
  • Monetize the API to reduce my hosting costs
  • Use my own funds if necessary.

The advantage of this kind of part-time project is that it doesn’t need to be profitable (though I will avoid letting it cost me $2,000 a month...), and my financial stability doesn’t depend on it.

Regarding the license, how do you know that it is under GPL?
Thanks a lot :)

Copy link
Member

@semuelle semuelle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the replies.

how do you know that it is under GPL?

They all contain a LICENSE file, like this one.

The advantage of this kind of part-time project is that it doesn’t need to be profitable (though I will avoid letting it cost me $2,000 a month...), and my financial stability doesn’t depend on it.

That's good to hear, though I should point out that we have had discussions with several explorer devs and providers and thus happen to know that the hosting and maintenance costs can be much bigger than that. Would you be willing to invest the time and resources required to run an in-demand explorer?

If you could rephrase the description of the project to focus on the work left to do, I'd be happy to have another look. Also, please review the deliverables and the licenses.

@semuelle semuelle added the changes requested The team needs to clarify a few things first. label Oct 24, 2024
@Apolixit
Copy link
Contributor Author

Hello @semuelle ,

I’ve updated the PR by splitting my “milestone 1” table into two parts:

  • Milestone 1: what remains to be done
  • Milestone 0: what has already been completed in the project
  • A Marketing and long term section to outline various approaches for making the project profitable

I’ve also updated the licenses of my projects in this commit, which will be merged into master in a few days.

Regarding the project description, I don’t believe it needs any changes.
I understand it’s standard not to accept retroactive payment, but I would like to emphasize that the work done so far also demonstrates the level of rigor I can bring to the project.

Let me know if you need anything else :)
Romain

@semuelle semuelle added ready for review The project is ready to be reviewed by the committee members. and removed changes requested The team needs to clarify a few things first. labels Oct 31, 2024
Copy link
Member

@semuelle semuelle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Apolixit, thanks for the updates and sorry for the long radio silence. I'm happy to proceed and will share the application with the rest of the committee once the milestone is renamed.

- **Total Costs:** 30,000 USD
- **DOT %:** Percentage of Total Costs to be paid in (vested) DOT: 50%

### Milestone 1 Example — Basic functionality
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @semuelle :)
It is done 👍

Copy link
Collaborator

@Noc2 Noc2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the application. I'm happy to go ahead with it.

Copy link
Contributor

@keeganquigley keeganquigley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your answers @Apolixit happy to also support it.

@PieWol
Copy link
Member

PieWol commented Nov 26, 2024

Hey @Apolixit ,
I'm happy to approve this application. 🎉

It's great to see that you strongly specify the deliverables for each milestone and already started working on this project prior to applying for a grant. I'm looking forward to your user friendly and visuals focussed blockchain explorer :)

Please complete the KYC process so that we can accept and merge this application. Thanks!

@Apolixit
Copy link
Contributor Author

Hello everyone :)

Thank you so much for your approval !
I have completed the KYC process.

How can I keep you updated on the milestones ?
Should I create a new PR each time I complete a feature and include the link to the PR in my project ?

Thank you very much,
Romain

@keeganquigley keeganquigley removed the admin-review This application requires a review from an admin. label Nov 26, 2024
@keeganquigley
Copy link
Contributor

keeganquigley commented Nov 26, 2024

Thanks @Apolixit I can confirm KYC has been approved :)

To answer your question, there is a separate repo for deliveries; when you are ready to submit a delivery, please create a PR here: https://github.com/w3f/Grant-Milestone-Delivery

No need to submit one for every feature, rather, you would submit once after all the deliverables in milestone 1 are completed. The way it is currently structured, we would basically make a one-time payment for the entire balance, upon completion of M1 per the acceptance of the evaluation. This would happen presumably in 4 months when you are finished.

If you anticipate needing to be paid before that date, I would recommend breaking up the features into two milestones, that way we would pay you half in 2 months, and the rest in 4 months, assuming you stick to the timeline. We pay per milestone, so for example if you wanted to be paid every month you'd need to create 4 milestones.

It's entirely up to you how you want to structure it. Keep in mind that 50% of DOT will be paid out with each milestone, which will effectively create separate vesting start dates.

If you want to change it please update the structure now before we merge it. Thx!

@semuelle semuelle merged commit ea8e05d into w3f:master Nov 27, 2024
8 of 9 checks passed
Copy link
Contributor

Congratulations and welcome to the Web3 Foundation Grants Program! Please refer to our Milestone Delivery repository for instructions on how to submit milestones and invoices, our FAQ for frequently asked questions and the support section on our website for more ways to find answers to your questions.

Before you start, take a moment to read through our announcement guidelines for all communications related to the grant or make them known to the right person in your organisation. In particular, please don't announce the grant publicly before at least the first milestone of your project has been approved. At that point or shortly before, you can get in touch with us at [email protected] and we'll be happy to collaborate on an announcement about the work you’re doing.

Also, if you haven't yet, consider signing up for the Polkadot Alpha Program. The program offers plenty of resources for people building on Polkadot. Lastly, please remember to let us know in case you run into any delays or deviate from the deliverables in your application. You can either leave a comment here or directly request to amend your application via PR. We wish you luck with your project! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for review The project is ready to be reviewed by the committee members.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants