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

[EPIC] overview and scope #2

Open
4 tasks
shorn-gnosis opened this issue Apr 3, 2024 · 0 comments
Open
4 tasks

[EPIC] overview and scope #2

shorn-gnosis opened this issue Apr 3, 2024 · 0 comments
Assignees
Labels

Comments

@shorn-gnosis
Copy link
Member

shorn-gnosis commented Apr 3, 2024

Goal:

Build an engaging interactive dashboard web app, enabling users to explore useful Circles data, with the goal being to educating them on how the Circles protocol works.

The interactive app will be hosted at [data.aboutcircles.com](http://data.aboutcircles.com)

Description:

The Circles Pathfinder Viewer is an interactive platform that allows users to explore and visualize data from the Circles protocol, a blockchain-based Universal Basic Income (UBI) initiative. The platform will provide two main features:

  • 1. Circles data viewer: a circles network traffic overview, with charts for key metrics - Circles network analytics view #3
  • 2. Path viewer: Path Viewer #4
  • 3. Trust graph explorer: Trust Graph Explorer #5
    1. Each node in the trust graph represents a user. So the nodes should be round profile pictures. If no picture is available, they are displayed in a solid color.
      1. Note: Profile pictures are currently only available from the [circles.garden](http://circles.garden) api. The max address count per request is 50 so larger queries must be batched
  • Sybil resistance demo #6
    1. Create different scenarios that show how Circles protects from Sybil attacks
      1. Can either be created on-chain and then put in a file, ..
      2. ..or can be completely synthetic
    2. Prepare the scenarios as json files
    3. Add the capability to easily load these files into the Trust Graph Explorer and Path Viewer
      1. Note: It should be possible to show both views at the same time (e.g. trust graph on the left and corresponding path on the right).
    4. Create a “slideshow” (simple previous/next buttons) that shows the different scenarios together with a text explanation section

The final web app will be deployed to netlify or vercel, and will integrate with the Circles API, Pathfinder and indexer service to fetch and process the necessary data.

Objectives:

  • Provide users with an intuitive and visually appealing way to explore and understand the flow of tokens and trust relationships within the Circles network.
  • Demonstrate the capabilities and potential of the Circles protocol and its underlying technology.
  • Possibly serve as an interactive information point at Circles events eg dappcon24

Scope:

  • Develop a Streamlit-based web application with a user-friendly interface for inputting addresses or usernames and generating the visualisations.
  • create a dune.com style dashboard page with interactive charts to show circles network data -
  • Integrate with the Circles API and Pathfinder service to fetch data on token flows and trust connections.
  • Implement the Path Viewer feature using Plotly and Sankey diagrams to visualise token flows between two points in the network.
  • Implement a visual representation of the limitations of transitive trust - TBD
  • Implement a "trust graph explorer" feature using D3.js to create an interactive graph of trust connections for a given user.

Basic requirements:

  • the web app should be built for desktop first (no mobile version atm), be reliable and performant, with real-world data.
  • provide clear documentation (readme) and instructions for users on how to interact with the platform and interpret the visualisations (both on [docs.aboutcircles.com](http://docs.aboutcircles.com) and with an in-app help system) - TBD

Ref UI idea:

Image

@shorn-gnosis shorn-gnosis self-assigned this Apr 3, 2024
@shorn-gnosis shorn-gnosis converted this from a draft issue Apr 3, 2024
@shorn-gnosis shorn-gnosis moved this from 🫡Todo to 🎯Active Epics in circles interactive web app Apr 3, 2024
@shorn-gnosis shorn-gnosis moved this from 🎯Active Epics to 💪Done in circles interactive web app May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Development

No branches or pull requests

1 participant