search

stacksgov / grants-program

Archive of past Stacks Foundation grant applications. Historical record of ecosystem development.
https://stacks.org/grants
141 stars 36 forks source link

Open Source BNS & BTC Leaderboard Bots For Twitter #305

Closed utkarsh23 closed 2 years ago

utkarsh23 commented 2 years ago

Background

The Ethereum community is extremely strong on Twitter, in part because they've been around for much longer. Various projects, ENS being one of them, have a huge following. I trust bitcoin like no other cryptocurrency and Stacks truly fascinates me.

I'd like more people to know about the Stacks ecosystem, and I think that BNS can be that exciting hook. When I first saw .btc names on twitter, that's the first time I started researching on Stacks and that's how I know what I know about Stacks.

Project Overview

I plan on building two twitter bots:

  1. BNS Bot - Tracks all BNS name registrations & transfers
  2. BTC Leaderboard - Leaderboard for twitter .btc handles

BNS Bot tracks registrations & transfers for BNS names, and also provides weekly stats on the registered names - total new names registered in the past week & top 3 namespaces.

As for the BTC Leaderboard, this bot tracks users with a .btc name in their twitter handles, and creates a leaderboard based on the number of followers for every such handle.

Scope

I've already built the BNS bot, which tracks registrations & transfers: https://twitter.com/bns_bot Source: https://github.com/utkarsh23/stacks-bots This bot updates once every hour. I'll also be adding weekly stats on the registered names.

The BTC Leaderboard bot would be similar to the ETH Leaderboard bot: https://twitter.com/ethleaderboard When a twitter handle breaks into top 25, the bot tweets out those notifications. The bot also tweets out a monthly review of the number of new handles that appeared, total number of handles & rank floors. There would be a frontend for the leaderboard, similar to https://ethleaderboard.xyz/ The leaderboard would also expose an API endpoint to retrieve this leaderboard data so it can be used within other applications built by the community.

Budget and Milestones

Total Grant Request: $7100

M1: BNS Bot Estimated work hours: 20 hours Amount: $2400

M2: BTC Leaderboard - backend Estimated work hours: 22 hours Amount: $2600

M3: BTC Leaderboard - frontend Estimated work hours: 17 hours Amount: $2100

Team

I'll be the only one working on this. You can view my GitHub profile: @utkarsh23

Community and Supporting Materials

I decided to open source this bot after someone DM'ed me on Twitter asking for the source. This same individual also suggested building out something similar to the ETH Leaderboard. I believe that as of now, few people have discovered the bot so while we're at it, I'd appreciate some help (maybe a shoutout on twitter) from the stacks community.

I have experience with the tech stack that I'll be using: Django + Celery Here's a platform I've built using this stack: https://github.com/utkarsh23/endorsity-club I also have decent experience with building frontends. Here's my website: https://utkarsh23.github.io/

stx-grant-bot[bot] commented 2 years ago

Thanks for submitting a grant proposal. Our team will review your submission and get back to you.

will-corcoran commented 2 years ago

@utkarsh23 Hi there!

Thanks for the proposal. We would like to support this effort. Before we give the grant final consideration, we would like you to make a couple of revision:

  1. Please revise your budget so that it is denominated in USD. It will be paid in STX, but we require applications to be in USD.
  2. Please add a scope item that turns your leaderboard efforts into an API endpoint so that others are able to utilize this data flow and add the dashboard to other projects and/or build new projects using that information.
  3. Please budget in producing proper documentation for the API and code base.

We look forward to your revised proposal.

Best, Will

utkarsh23 commented 2 years ago

Hey @will-at-stacks,

I've revised the proposal with the following changes:

  1. Changed the budget so that it is denominated in USD.
  2. Changed the scope of M2 to include exposing a paginated API endpoint that would allow developers to include leaderboard data into their applications. The scope will also include creating a redoc documentation with curl examples for this endpoint.
  3. Changed the scope of M3 to include documentation for the entire codebase.

Regards, Utkarsh

will-corcoran commented 2 years ago

@utkarsh23 thank you for revising the application. This is approved! Please use this link to schedule a meeting with us to demo your work when you are done. Thanks, Will

stx-grant-bot[bot] commented 2 years ago

Congratulations. Your grant is now approved. Please complete the on-boarding link here: https://grants.stacks.org/onboard?q=4a3c31676c6d2f5626930f0c168d7f32

will-corcoran commented 2 years ago

Hello and thank you for participating in the Stacks Foundation Grants Program!

We are in the process of migrating from GitHub to the new Grants Dashboard. In order to complete your grant, you will need to submit any remaining Progress Review and/or Final Review requests through the Dashboard in order to receive your remaining payments.

Lastly, please note we are marking this grant 'closed' on GitHub for organizational purposes, but it is still 'open' on the Grants Dashboard.

Thanks and we hope to continue to support your efforts with additional grants!

Best, Will

will-corcoran commented 2 years ago

Hi @utkarsh23 I am going to cancel our meeting. I don't believe it is necessary for us to meet tomorrow. please reach out to the email addresses above if you have any questions. Thanks, Will