[Epic] Singularity App

[xinaxu]

Description

ETA: 2023-11-30

A dashboard to explore the prepared dataset. At the first stage, the dashboard is read only, the implementation needs to account for potential future feature that makes it interactive, i.e. creation / update of dataset, data source, etc.

Global View

• Instance ID
• Version
• About page

  Wallet List View

• Show a list of wallets
• For each wallet, show associated datasets
• For each wallet, can also show associated deal schedules
• Add wallet using private key
• Remove wallet

  Global Dashboard View

• Charts for deals, i.e. deals breakdown by state, SP, dataset, time series
• Charts for data prep, i.e. number of files, number of CARs, total size of files

  Workers view

• List of workers and their status

Dataset Selection

• Select a dataset to get to Per Dataset view
• Create / Remove dataset - Dataset Creation View

Dataset Creation View

• Name
• maxSize, pieceSize
• Encryption key

Dataset Connect to destination View

• Output Destination - can be all supported types, i.e. local path, S3, Dropbox, etc

Per Dataset view

Datasource List View

• List of datasource
• Add / remove datasource - deleteAfterExport, rescanInterval, etc

  Wallet association View

• Add / remove wallet association

  Piece List View

• List of pieces that have been prepared
  • each piece has link to PieceFileListView and PieceDealView
• Add new piece manually (piece_cid, piece_size, [root_cid])

Deal Schedule List View

• List of deal schedules associated with this dataset and their status, link to Deal Schedule View
• A button to create new deal schedule
• Pause / Unpause

Deal Schedule Creation View

• see database schema

Per Dataset Dashboard

• Charts for deals, i.e. deals breakdown by state, SP, dataset, time series
• Charts for data prep, i.e. number of files, number of CARs, total size of files

Deal Schedule View

• parameters, i.e. provider, client, cron pattern, restriction, deal parameters
• Chart for deals made by this schedule, time series, pie chart, etc

Per Datasource View

Onboarding View

• Explore datasource by path and enqueue items from datasource
• List of enqueued items

  Exploration View

• Explore prepared files by path
• Each file goes to File View

File view

Default to last version of file and user can see and choose previous versions

• Download button which renders a File Download View
• List of pieces that includes this file (1 for small files, and more for large files)
• Show all relevant deals and charts for distribution

### Tasks
- [ ] https://github.com/data-preservation-programs/singularity/issues/282

[xinaxu]

Feedback from Pauli In an ideal world, for singularity V2, there would be dataset page where I can click in to find the following info:

• find all the references, dag, deal cid, piece cid etc (just list them all, the community seems to confuse them)
• list the replicated SPs with a status eg 100% or green or orange for some deals that have not made it or red for all that have failed. The error message from the SP should also be reported. eg, price too low or file size too low
• for each SP list the sector that contains the deal (means talking to Boost)
• finally the ability to re-queue or re-run the replication process to bring all the SP status up to 100% (green)

[celine3650]

This is the current Figma. https://www.figma.com/file/mRg6izXLreoZw375ZCvPzD/Draft-v1---Data-onboarding-Wireframes?type=design&node-id=0-1&mode=design&t=TRSPN7fZ1vM7kce7-0