singularity

Singularity

The new pure-go implementation of Singularity provides everything you need to onboard your, or your client's data to Filecoin network

Current Status

This project is currently in active development. Below are the current feature list and their status.

	Feature is stable and ready for production use
	Feature is in beta and may still contain bugs
	Feature is in alpha and should not be used in production
	Feature is currently being worked on and is not usable
	Feature is planned but not yet implemented

Category	Feature	Status	Description
Data Source	File System		Support for preparing data on local file system
Data Source	Nginx File Browser		Support for preparing data from Nginx directory listing service with autoindex turned on
Data Source	S3 Compatible		Support for preparing data from S3 compatible storage service
Data Prep	Create Dataset		CLI tool for creating dataset
Data Prep	Add Data Source		CLI tool for adding data sources to existing dataset
Data Prep	Inline Preparation		Support for inline preparation. No need to export CAR files
Data Prep	Upload API		Support for manually upload files via API
Data Prep	Push API		Support for manually queue a new item with an item path via API
Data Prep	Dag regen		Regenerate the unixfs dag to update the root CID of the whole dataset
Data Prep	Basic Encryption		Support for basic encryption with asynmmtric keys
Data Prep	Custom Encryption		Support for custom encryption with user providing encryption tools
Content Provider	HTTP piece		Support for HTTP piece download (CAR file download)
Content Provider	IPFS gateway		Support for IPFS Gatway compliant retrieval
Content Provider	Bitswap		Support for Bitswap retrieval (IPFS interop)
Content Provider	Graphsync		Support for Graphsync retrieval
Content Provider	Metadata API		Allow CAR file distribution from the original data owner
Content Provider	Donwload Client		Support downloading CAR file from the original data owner with the help of Metadata API
Deal Making	Deal Tracking		Track deal status
Deal Making	Deal Scheduler		Feature parity with js-singularity deal replication
Deal Making	Spade API		Support for compatible Spade API for storage provider to self proposal deals
Deal Making	Wallet Management		Support for wallet management
Deal Making	Remote Signer		Support for remote signer
Utilities	Benchmark		Support for benchmarking data preparation
Utilities	Monitoring		Support for monitoring data preparation and deal making
Dashboard	Dataset Explorer		Support for exploring dataset, folder by folder
Dashboard	Dataset Download		Support for downloading dataset directly on the browser
Dashboard	Deal Explorer		Support for exploring deal proposals
Dashboard	Piece Explorer		Support for exploring by piece CIDs and check distribution
Dashboard	Provider View		Support for checking how fast providers are consuming the deals

Related projects

• js-singularity - The predecessor that was implemented in NodeJS
• js-singularity-import-boost - Automatically import deals to boost for Filecoin storage providers
• js-singularity-browser - A next.js app for browsing singularity made deals
• go-generate-car - The internal tool used by js-singularity to generate car files as well as commp
• go-generate-ipld-car - The internal tool used by js-singularity to regenerate the CAR that captures the unixfs dag of the dataset.