Stacks Monitor: a real-time analytics tool by Stackture

fintechrecruiters commented 4 years ago

We prefer clear, concrete, and concise applications. If an application is incomplete or unclear, we will request an update to the application.

Background

Stackture creates tools and services that provide actionable insights to promote and grow the Stacks ecosystem. Our real time analytics tools and services focus exclusively on the Stacks network. These dedicated services and tools allow regular stacks holders, crypto analysts, developers and institutional investors to interpret, understand, take action and participate in the Stacks ecosystem.

What problems do you aim to solve? How does it serve the mission of a user owned internet?

The Stacks Monitor will allow users to view and understand the efficiencies of the Stacks network in a transparent and visually appealing way.This increased transparency contributes and supports the user's ability to make better decisions about Stacks on insights gathered from this tool. We believe that transparent tools like the Stacks Monitor contribute to the larger discussion of a user owned internet that empowers users to make decisions based on real time data rather than their own data being used to imprison them.

Project Overview

What solution are you providing? Who will it serve?

Our first analytics tool is called the Stacks Monitor, which is an analytics layer of the Stacks blockchain that provides useable data on a rich user interface dashboard. This data is from raw transactions and various breakout or data aggregation sources. It consists of metrics based on 5 categories:

1) Transfers 2) Smart Contracts 3) Stacking 4) Accounts (wallets), 5) Node map

The data displayed on the dashboard gives users a detailed overview of the Stacks ecosystem.

The Stacks Monitor is for stacks holders, crypto analysts, developers, institutional investors and anyone else who would like to gain a deeper insight into the Stacks network.

Scope

What are the components or technical specs of the project? What will the final deliverable look like? How will you measure success?

The Stacks Monitor analytics tool has the following components displayed as metrics:

Transfers

With dataset created with selected date span; Default date span is last 24 hours by default. It can be changed with a date picker.

1- Summary of transfers made. Total amount represented as STX and USD.

2- Date histogram line chart.

3- Largest transfers list. Sorted by transfer amount and reduced to 6 rows.

4- Full transfers data list. Allows filtering, sorting, and exporting.

Notes Transfer amounts represented as STX and USD on list item. Raw tx data can be viewed by clicking tx link on list items.

Wireframes

https://stacksmon-files.runkodapps.com/kMSXqMI.png

https://stacksmon-files.runkodapps.com/iydlFtR.png

Smart Contracts

Summary page

With dataset created with selected date span; Default date span is last 24 hours by default and can be changed with a date picker.

1- Summary of smart contract calls made.

2- A text input to enter contract address and go to smart contract detail.

3- Date histogram line chart.

4- Top Smart Contracts. Sorted by call count and reduced to 6 rows.

5- Full data list. Allows filtering, sorting, and exporting.

Notes List items linked to contract detail page.

Wireframes

https://stacksmon-files.runkodapps.com/ltyav2V.png

https://stacksmon-files.runkodapps.com/dbIOSBF.png

Contract detail page

1- Function call distribution table & pie chart

2- Call history list. Sorted by transfer amount and reduced to 6 rows.

4- Full call history list. Allows filtering, sorting, and exporting.

Notes Raw tx data can be viewed by clicking tx link on list items.

Wireframes

https://stacksmon-files.runkodapps.com/Q6wuboK.png

https://stacksmon-files.runkodapps.com/7zqnvdW.png

Stacking

1- Counter to next cycle.

2- Summary of rewards distributed on previous cycle. Total amount represented as BTC and USD.

3- Largest rewards on previous cycle. Sorted by amount reduced to 6 rows.

4- Full rewards data list of previous cycle. Allows filtering, sorting, and exporting.

5- Summary of rewards distributed to date in total. Total amount represented as BTC and USD.

6- Date histogram line chart. Visualization of rewards over cycles.

7- List of previous cycles. Clicking list items opens full data on new modal dialog. Allows filtering, sorting, and exporting.

8- List of stacking pooling providers.

Notes Reward amounts represented as BTC and USD on reward list items. Raw tx data can be viewed by clicking tx link on reward list items.

Wireframes

https://stacksmon-files.runkodapps.com/ttShCNr.png

https://stacksmon-files.runkodapps.com/EBG44Cj.jpg

Accounts (or wallets)

1- Summary of total STX in circulation. Total amount represented as STX and USD.

2- Largest wallets list

3- Exchange wallets list

Wireframes

https://stacksmon-files.runkodapps.com/9hYpOzM.png

Node Map

Locations of live peer nodes on a world map.

The final deliverable will be based on the sections above; however some components may not be available because they are dependent on raw data from the Stacks blockchain mainnet.

The success will be measured based on community feedback, measurable website metrics such as time spent on the site, number of clicks, the time spent on each page, section, etc. (privacy by design analytics tools)

Budget and Milestones

What grant amount are you seeking? How long will the project take in hours? If more than 20, please break down the project into milestones, with a clear output (e.g., low-fi mockup, MVP with two features) and include the estimated work hours for each milestone.

We are seeking a grant of $5000. The project will take 135 hours to complete. Here's a breakdown of the project:

Application design and architecture decisions. [5 hours]
Database design, data importers and indexers. [30 hours]
Backend, data filtering and aggregation endpoints. [40 hours]
Frontend design & implementation. [40 hours]
Beta release 🎉
Bug fixes. [5 hours]
Stable release 😎

We are planing to push at least 6 blog posts for status updates, announcements and helpful information sharing during and after development process. [3x6 = 18 hours]

135 hours of development & project management & content creation efforts.

135 * 35$ (average hourly rate) = 4830$

Additional expenses

Hosting expenses for 5 months. ~40$/month * 5 = 200$

= 5030$

We estimate to deliver first stable version in 5-6 weeks.

Technical Details

We are building Stacks Monitor with Elasticsearch which is an industry leader in analytics solutions.

It provides us with a very flexible infrastructure to create meaningful results on blockchain data with very detailed filters. And it will help us to create a flexible and fast public API at later stages of the project which we will provide all the data we have to other developers.

Team

Who is building this? What relevant experience do you bring to this project? Are there skills sets you are missing that you are seeking from the community?

Nako Mbelle, CEO and Co-Founder - Charletta Bullard, COO and Co-Founder

Nako is a fervent believer in community driven technology that empowers and promotes the sovereign right of the individual to shape their digital lives. She's the Founder of Fintech Recruiters, a niche recruitment agency that specializes in blockchain, crypto and Fintech jobs.

Charletta is a frontend developer with a knack for fixing bugs and handling security related issues. She enjoys educating clients about privacy by design technological alternatives and spreading the word about migrating to digital identity tools and platforms geared toward a user owed internet.

Risks

What dependencies or obstacles do you anticipate? What contingency plans do you have in place?

What may slow down this project is the lack of all of the necessary data points needed to display the information outlined above. Our contingency plan is to use any existing data and aggregate data from the web that pertains to Stacks. If we need to change some of our Stacks chain activity measurements to reflect the existing data; we will do so.

Community and Supporting Materials

Do you have previous projects, code commits, or experiences that are relevant to this application? What community feedback or input have you received? How do you plan to share your plan to the community over time and as the final deliverable?

Talha has experience with building social media analytics tools and search engines. Main contributor of this particular open sourced repo which slightly relevant to this project. Indexer of hivesearcher. Search engine for HIVE blockchain.

We are planning to push status update blog posts to inform community about progress.

We haven't received any feedback from the community yet. We are expecting to get feedback from the Stacks community with this grant application.

If you have any questions or suggestions about this project please let us know. We can be reached on Discord at username talha#4404 and Nako#1803 or sign up to our waiting list on stackture.co

RaffiSapire commented 4 years ago

Hi there! How are you pulling data from mainnet? Is this dependent at all on STX 2.0? If you were to kind of break down the app into a couple steps, what could the first deliverable be? E.G., start by just showing data for the summary page. Would like to award the grant in chunks as you go.

fintechrecruiters commented 4 years ago

Hi there! How are you pulling data from mainnet? Is this dependent at all on STX 2.0? If you were to kind of break down the app into a couple steps, what could the first deliverable be? E.G., start by just showing data for the summary page. Would like to award the grant in chunks as you go.

The system will be highly dependent on the raw transactions of STX blockchain. However we will use extra helper API's.

We will fetch transaction data from stacks-blockchain-api. (Like official Stacks Explorer does.)

We will use coingecko api to fetch currency market info to represent amounts as USD and bitcoin.

We will use /v2/neighbors endpoint of blockchain to get ip addresses of active nodes.

We will use geolocation-db.com's api (or an alternative) to get location from ip addresses to visualize on the world map.

We can break down deliverables like this:

1- Transfers, Accounts (wallets) 2- Smart Contracts 3- Stacking, Node map

blocks8 commented 4 years ago

Review Committee Feedback from 10/6/2020: We'd like more information on your proposal.

Thank you for your submission! We'd like to see the milestones and related funding broken down into smaller segments. Each to include a milestone, deliverable, and amount of funding for each. I'll show a rough example based on your submission, but please update to reflect what you see as better pieces/deliverables:

Milestone 1: $500 Application design and architecture decisions. [5 hours] Deliverable: Visuals shared with the community

Milestone 2: $2000 Database design, data importers and indexers. [30 hours] Backend, data filtering and aggregation endpoints. [40 hours] Deliverable: Beta app shared with community for testing

etc...

We look forward to learning more and seeing updates to the milestones!

fintechrecruiters commented 4 years ago

Milestone 1 1500 $ Application design and architecture decisions. [5 hours] Database design, data importers and indexers, server setup and configuration. [30 hours] Status update blog post [3 hours] Deliverable: Available code with public repo address shared with the community.

Milestone 2 1000 $ Frontend design. [16 hours] "Transfers" module implementation. [10 hours] "Accounts (wallets)" module implementation. [10 hours] Status update blog post [3 hours] Deliverable: Alpha release with completed modules.

Milestone 3 1000 $ Bug fixes on previously released modules. [1 hour] "Smart Contracts" module implementation. [20 hours] Status update blog post [3 hours] Deliverable: New modules and bug fixes deployed to online.

Milestone 4 1000 $ Bug fixes on previously released modules. "Stacking" module implementation. [10 hours] "Node map" module implementation. [10 hours] Status update blog post [3 hours] Deliverable: All modules completed. Beta release.

Milestone 5 500 $ Bug fixes [5 hours] Status update blog post [3 hours] Deliverable: Stable release.

RaffiSapire commented 4 years ago

Hi there, We're pleased to approve this grant. The next step will be to send you over a contract so we can disburse payment at the given milestones. Please email grants@stacks.org with your contact information and we'll send you a contract via bill.com.

RaffiSapire commented 3 years ago

Hi there, if you would still like to pursue this grant, please sign the contract Brittany has sent by Friday, and please post here with an updated timeline given the delay here. Thanks! @fintecrecruiters

blocks8 commented 3 years ago

Update: Contract signed. Milestone 1 is now funded for $1,500.

fintechrecruiters commented 3 years ago

@blocks8 @RaffiSapire Talha Bulut, the CTO has left the project. A search for another Technical Partner is underway. Please advise if this grant submission should be closed and funds returned.

fintechrecruiters commented 3 years ago

Hi there, if you would still like to pursue this grant, please sign the contract Brittany has sent by Friday, and please post here with an updated timeline given the delay here. Thanks! @fintecrecruiters

Stacks Development Grant Agreement.pdf

I didn't see the request to upload the signed contract until now. Please see attached agreement.

RaffiSapire commented 3 years ago

Thanks. Ah that's a bummer! Sorry to hear that. Can we be helpful in trying to find a partner for you? Let us know how we can help make it happen. Have you shared about what you're working on in discord?

fintechrecruiters commented 3 years ago

Thanks. Ah that's a bummer! Sorry to hear that. Can we be helpful in trying to find a partner for you? Let us know how we can help make it happen. Have you shared about what you're working on in discord?

I've reached out to a few developers as possible replacements. If I don't have any luck on my end, I will post it on discord and the forum. Thanks for asking. I'll keep you posted.

fintechrecruiters commented 3 years ago

Update: @blocks8 @RaffiSapire @charletta Charletta Bullard has joined me as the new Co-Founder of Stackture. She will replace Talha Bugra Bulut as the Lead Technical Partner on this project. Thanks for your patience and we look forward to delivering the project in a timely manner.

RaffiSapire commented 3 years ago

Hi there! Please email me at Raffi@stacks.org to help you get set up on bill.com for the M1 here.

fintechrecruiters commented 3 years ago

@blocks8 @RaffiSapire

https://www.figma.com/file/fUhNl3n6Bu7hQuuFnrwXZm/StackedSats-(for-feedback)?node-id=1%3A3

https://www.loom.com/share/aebfa49cca7c418cb2f6960657e38f88

Please note that due to resource and time constraints I combined the Stacks Monitor with the Stackedsats pooled services. The Stacks Monitor will appear within the Dashboard of the Stackedsats website. The details below cover the Frontend of Stacks Monitor(Milestone 2 and 3) and the backend (Milestone 4 and 5) is still being built which includes the API feeds. I will post the backend in a few days (Jan 4th)

Stacks Monitor (Milestone 2 and 3 using React.js Frontend)

Work Summary - Dashboard Skeleton App built in React This is a pure HTML & CSS React Skeleton app with planned and separated into components as well as menus with all routes and interactive elements in place. All front end functionality will be complete and the only thing left to do is to hook up to the live data to populate the dashboards and graphs.

Please note that some complex graphs will not be coded as html and css as these will be created using a React graphs plugin that will need to be connected to the data by the developer and the graphs plugin will handle the generation of the markup for these.

Set up React Base Application Est - 2hrs This involves creating, scaffolding and preparing the React application.

-all the necessary node modules -component and folder structures -Routes -Pages -Environment variables

Create Base/Common Layouts - 8hrs These are the most common re-usable elements that appear on all pages of the dashboard. Created as reusable React components to be included in all pages. .1 Base Structure - 2hrs

The first step to coding the dashboard is to create the base layout structure that everything else will go into. This will form the basis of the main app structure as well as ensure everything works on all screen sizes.

Creating the main top level sections first as placeholders and then building out each main section as outlined below.

Top Navbar Sidebar Page Header Main Content Area Footer Navigation .2 Top Navbar - 2hrs Logo Search Input User Avatar & Dropdown Includes Initial Placeholder eg: A for Andrew of N for Nako - if no User photo or User photo if user adds Photo Include a dropdown on user click that contains user info and buttons to become a miner and log out

.3 Sidebar - 2hrs Nested navigation with primary nav and sub nav with icons and includes collapsible panels

Bottom placeholder in sidebar menu for Next reward cycle and Become STX miner action button

Page Section Header - 1hr30min This is the section above the content on each page that has the page name and some other info. The page name needs to be dynamically added based on the pages route/name and the action and content on the right is unique depending on the page context

Page Title Under page title - Date / Date Ranges etc (this content changes per page) Right - Total STX, Next reward cycle etc

The 2 sections that need to change need to use component slots to handle the changing content.

Footer Menu - 30min Footer Navigation with links connected to external social media, contact and blog pages.

Create Common Styles - Style Guide - 2hrs I have extracted all the common smallest components that make up the rest of the design and will code these first as they will be used in all other components. These form a style guide for everything else.

Buttons - Solid and Outline Typography Badges Color Variables Form inputs and elements Tabular Data - Used in cards

Create Common Components - 14hrs I have extracted all the various complex components that make up the rest of the design. Cards - Normal & Tabbed - 3.5hrs A large part of the Dashboard is made up of different types of normal and tabbed cards. A base card and tabbed cards component will be created to cater for the various layouts in the app to make building out the various pages easier.

Eg: this card has a set of Data with a Transfers and Largest Transfers tab with different data sets in each

Context Menu - 1hr30min

Some elements have a context menu. When a user clicks an element a menu shows with various links in it. This component will be reusable and will be able to contain different links based on the context.

Next Reward Cycle - 2.5hrs

This is a countdown timer that displays a timer that is counting down from a specified date and time.

Tooltips - 1hr

Displays some data on hovering over an element

Navigation Cards - 30min A card that container an icon and link with a hover state.

Modals & Modals with steps - 3hr A reusable Modal component that displays data. The modals in the design has next and previous steps inside the modal.

I will create a single reusable modal as well as a stepped modal component.

Previous Cycles Graphs - 2hrs

This is a specific graphical representation that will not be available in a normal graphing component and will need to be coded specifically for this purpose.

Pages - 11Hours Once base app and all components are built each page will be built using the components built with the specific content and sections and layouts for each page specifically.

fintechrecruiters commented 3 years ago

Hi there! Please email me at Raffi@stacks.org to help you get set up on bill.com for the M1 here. I'm already set up with bill.com. I've submitted the necessary paperwork to Brittany @blocks8 and have received M1. I've recently submitted Milestone 2 and 3.

fintechrecruiters commented 3 years ago

@RaffiSapire @blocks8

Here's an update for the Stacks Monitor now called Mining Analytics and Stacking Analytics which are a part of M2 + M3 = $2000

Deliverable: https://www.figma.com/file/FnNpR1j5Owdhc110KSdWlv/StackedSats?node-id=528%3A18

M4 is still pending.

fintechrecruiters commented 3 years ago

Update: M2 + M3 https://github.com/StackedSats

RaffiSapire commented 3 years ago

Hi @fintechrecruiters , I've released capital for M2+3 to continue on this work! Thank you.

fintechrecruiters commented 3 years ago

Hi @fintechrecruiters , I've released capital for M2+3 to continue on this work! Thank you.

$2000 received. Thank you

RaffiSapire commented 3 years ago

Hi @fintechrecruiters , what is the status of this grant currently?

fintechrecruiters commented 3 years ago

Hi @fintechrecruiters , what is the status of this grant currently?

First 3 milestones that encompass UI/UX design and frontend (CSS, HTML, JavaScript)coding are complete. 90% of backend tasks are complete and we still need to test and connect API calls to display data and stacks blockchain metrics.

All of the code is in the repo and has been open sourced and shared. Some of the elements in the dashboard which is a part of the stackedsats pooling service has been forked already by Stacks community members.

I will submit M4 with comments when completed.

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

M2 has been funded! When you are finished with this milestone, please comment on this issue with !m2_complete

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

M1 has been funded! When you are finished with this milestone, please comment on this issue with !m1_complete

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

M2 has been funded! When you are finished with this milestone, please comment on this issue with !m2_complete

fintechrecruiters commented 3 years ago

@RaffiSapire fyi @jennymith @blocks8

This message is to provide an update on Grant #21 - Stacks Monitor: real-time analytics tool that I originally started last year.

1) Fast forward a few months (6 months later) and the project is 85% complete.

2) The total budget for this project was $5000 USD; however, the data science and analytics skills required to connect the live streaming data for the dashboard was beyond the scope of the fullstack engineer who built the dashboard. This project requires an experienced Data Engineer/Scientist to finish and maintain the dashboard. Unfortunately, this was not something that was originally accounted for, for a contract developer outside of the Stacks ecosystem.

3) The devs that built the backend and frontend do not have the data streaming skills required to complete this project. See links in M1 and M2. So here's what I suggest:

a) Stop the last 2 milestone payments: M3 and M4 because the final data streaming portion has not been delivered and the project can be turned over to the community to fork and complete.

b) Solicit Data Engineers within the community to complete the project with a bounty equivalent to the amount for M3 and M4.

c) Get additional quotes from Data Engineers (contractors) to complete the project which would mean applying for another grant to complete the live streaming portion of the project.

I look forward to your feedback and suggestions. Thanks in advance.

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

M2 has been funded! When you are finished with this milestone, please comment on this issue with !m2_complete

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

M2 has been funded! When you are finished with this milestone, please comment on this issue with !m2_complete

RaffiSapire commented 3 years ago

Hi @fintechrecruiters ! How are you? Wanted to check in and see if you had any updates to share?

fintechrecruiters commented 3 years ago

Hi Raffi,

I’m having issues finding a Data Engineer who will work with me on completing the data analytics and data streaming portion of the project.

I left an update in GitHub 3 weeks ago as a request to halt funding for M3 and M4 because I didn’t know the difficulty of the data streaming portion of this project. It looks like the bot picked up the update as a funding submission.

Here’s the update left in GitHub

@RaffiSapire https://github.com/RaffiSapire fyi @jennymith https://github.com/jennymith @blocks8 https://github.com/blocks8

This message is to provide an update on Grant #21 https://github.com/stacksgov/Stacks-Grants/issues/21 - Stacks Monitor: real-time analytics tool that I originally started last year.

1.

Fast forward a few months (6 months later) and the project is 85% complete. 2.

The total budget for this project was $5000 USD; however, the data science and analytics skills required to connect the live streaming data for the dashboard was beyond the scope of the fullstack engineer who built the dashboard. This project requires an experienced Data Engineer/Scientist to finish and maintain the dashboard. Unfortunately, this was not something that was originally accounted for, for a contract developer outside of the Stacks ecosystem. 3.

The devs that built the backend and frontend do not have the data streaming skills required to complete this project. See links in M1 and M2. So here's what I suggest:

a) Stop the last 2 milestone payments: M3 and M4 because the final data streaming portion has not been delivered and the project can be turned over to the community to fork and complete.

b) Solicit Data Engineers within the community to complete the project with a bounty equivalent to the amount for M3 and M4.

c) Get additional quotes from Data Engineers (contractors) to complete the project which would mean applying for another grant to complete the live streaming portion of the project.

I look forward to your feedback and suggestions. Thanks in advance.

On Mon, Jul 26, 2021 at 5:15 PM Raffi Sapire @.***> wrote:

Hi @fintechrecruiters https://github.com/fintechrecruiters ! How are you? Wanted to check in and see if you had any updates to share?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/stacksgov/Stacks-Grants/issues/21#issuecomment-887032334, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJTC3NDIS5VAGWJEEKRZVPTTZXGANANCNFSM4R7LK7BA .

-- Nako Mbelle Fintech Recruiters Crypto and Blockchain Connector Phone:646-233-4050 or 416-948-4050

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.

If you have questions about the Grants Dashboard in general please email ambassadors@stacks.org.
If you have questions regarding payments and/or contracts please email payments@stacks.org.

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

stacksgov / grants-program