Skip to content

Latest commit

 

History

History
257 lines (255 loc) · 14.2 KB

index.md

File metadata and controls

257 lines (255 loc) · 14.2 KB
layout title date page_sections
blocks
Fair Data Protocol
2017-11-22 23:00:00 +0000
template block logo navigation cta
navigation-header-w-button
header-2
/uploads/2022/10/03/fairdata.svg
url button_text
GitHub
template block slug headline content cta image background_image
hero-banner-w-image
hero-2
features
Fair Data Protocol
Developed under Fair Data Society, Fair Data Protocol aims to provide web3 storage for dApps to connect and use, allowing for fair access and re-use of data on a global scale.
enabled url button_text
true
See on GitHub
image alt_text
/uploads/2022/06/11/ferdinand-stohr-nfs6drtbgam-unsplash.jpeg
template block col_1 col_2 col_3
3-column-text
three-column-1
slug content headline
Fair Data Protocol interoperability has several layers, where independence from a data providers open up new opportunities to share and reuse data.
Interoperability
headline slug content
Self Sovereignty
Fair Data Protocol enables independence from clouds and data silos by relying on the network of peers to host the data giving end users ultimate control.
headline slug content
Privacy
Fair Data Protocol enables a private space in the decentralized cloud, the prerequisite for digital freedom.
template block media_alignment content headline slug media
content-feature
feature-1
Right
Fair Data Protocol provides various libraries and tools for developers to build using it. <br><br>The underlying storage is FairOS-dfs, based on Swarm decentralized storage. It can be accessed through browser libraries or a dedicated client.<br><br>Blossom is a browser extension that allows dApps to access the personal storage of users. By integrating with its framework, the wallet handling is no longer a question for dApps and users have single-sign-in (SSI) to log in their account.<br><br>Various other libraries are provided for more special use cases. <strong><br><br>FDP Play</strong><br>FDP Play is entry point for developers to start building with FDP - a CLI tool to spin up local development FDP environment with Docker. It includes a Bee cluster, FairOS instance and blockchain node. The GitHub code and instructions are <a href="https://github.com/fairDataSociety/fdp-play" title="">here</a>. Click and press play!<br><br><strong>FDP CLI</strong><br>This simple CLI application helps you to interact with all base functionalities of FDP. Currently, it manages the Personal Storage and accounts. You can install it easily from <a href="https://www.npmjs.com/package/@fairdatasociety/fdp-cli" title="fdp-cli-npm">NPM</a>.<br><br><strong>Fair Data Protocol Tutorials</strong><br>A <a href="https://github.com/fairDataSociety/tutorials-fairdrive/blob/main/FDP-TUTORIAL.md" title="Getting Started with FDP">Getting Started with FDP</a> tutorial explains creating a decentralized application using Fair Data Protocol (FDP) and Swarm, creating an example spreadsheet dApp.<br><br>An interactive tutorial for developers on getting started with Fair Data Protocol is available <a href="https://github.com/fairDataSociety/fdp-storage-tutorial/" title="FDP Tutorial">here</a>. The first part involves setting up a development environment with fdp-play and using fdp-storage.<br>A quickstart example todos app based on the tutorial above is available <a href="https://github.com/fairDataSociety/fdp-storage-todos" title="TODOs example app">here</a>.<br>
Fair Data Protocol Toolkit
image alt_text
/uploads/2022/10/04/dalle-2022-10-03-23-17-40.png
FDP Toolkit
template block media_alignment headline content slug media
content-feature
feature-1
Left
Applications
Application ecosystem around Fair Data Protocol is growing daily. Below are a few applications that might inspire you to develop your own.<strong><br></strong><br><strong>Fairdrive Desktop App</strong><br>Fairdrive Desktop App opens the self-sovereign cloud to individual users. <br>It is a FUSE client for FairOS-dfs and lets you mount your pod on your own user space and interact with your files as if they were on your local computer.<br>You can access the GitHub <a href="https://github.com/fairDataSociety/fairdrive-desktop-app" title="Fairdrive Desktop App">here</a> or install it by following <a href="https://fairdatasociety.github.io/fairdrive-desktop-app/" title="FDA Instructions">instructions</a>. <br><br><strong>Fairdrive Web App<br></strong>Fairdrive Web App is a dApp that you can use from your browser, using the same underlying storage as the Desktop App. <br>It consists of a typical "Drive" interface with files and folders, making it convenient for end users. You can access the GitHub<span class="Apple-converted-space"> </span><a href="https://github.com/fairDataSociety/fairdrive-theapp" title="">here</a> or try it out <a href="https://join.fairdrive.io/" title="FD Web App">here</a>. <br>Read more about Fairdrive by going to Fairdrive <a href="https://fairdrive.fairdatasociety.org/" title="Fairdrive">page</a>.<br><br><strong>FairPass<br></strong>A decentralized password manager built with FairOS on top of Swarm storage. It can save "passwords" and "notes" and works for desktop and mobile. You can access the GitHub<span class="Apple-converted-space"> </span><a href="https://github.com/fairDataSociety/FairPass" title="">here</a>.
image alt_text
/uploads/2022/10/04/dalle-2022-10-03-23-23-57.png
Applications
template block media_alignment slug headline content media
content-feature
feature-1
Right
customize
FairOS
<strong>FairOS-dfs</strong><br>FairOS-dfs is a layer on top of Swarm decentralized storage, that offers more advanced data structures - drive, folder and files hierarchy; a key value store and a document store. For implementation in Golang the documentation is <a href="https://docs.fairos.fairdatasociety.org/docs/" title="">here</a>.<br><br><strong>FDP Storage</strong><br>FairOS-dfs implementation in JavaScript, can be run in browsers. You can access the GitHub <a href="https://github.com/fairDataSociety/fdp-storage" title="fdp-storage">here</a>. Watch an explainer <a href="https://youtu.be/pxYk552e4js" title="fdp-storage video">video</a>.<br><br><strong>FairOS in WASM</strong><br>FairOS-dfs library in WASM. You can access the GitHub <a href="Fairdrive is a dApp that enables decentralized storage on Swarm. It consists of a typical &quot;Drive&quot; interface with files and folders, and a BZZ wallet to manage token balances and keypairs. " title="">here</a>.<br><br><strong>FairOS Connect</strong><br>A set of convenience components that can be included in dApps to support FairOS. These components were used in the reference Fairdrive App. You can access the GitHub<span class="Apple-converted-space"> </span><a href="https://github.com/fairDataSociety/fairos-connect/" title="">here</a>.
image alt_text
/uploads/2022/10/04/dalle-2022-10-03-23-17-19.png
FairOS
template block media_alignment headline content slug media
content-feature
feature-1
Right
Blossom
Blossom browser extension serves as a framework for Fair Data Protocol developers and an environment for Web3 users acting as their user agent allowing Single Sign In. It provides complete traceless Web3 browsing, handles the user wallet and provides a FDP Storage interface for managing the User Personal Storage for dApps.<br>To quickly get started check <a href="https://fairdatasociety.github.io/blossom/" title="Blossom Browser Extension Getting Started">this guide</a>.<br>You can access the GitHub documentation <a href="https://github.com/fairDataSociety/blossom" title="Blossom repo">here</a>.
image alt_text
/uploads/2022/10/04/dalle-2022-10-03-23-22-40.png
Blossom
template block media_alignment headline content slug media
content-feature
feature-1
Left
BeeSon
BeeSon is a JSON compatible serialization format which allows its elements to be verified cheaply on-chain. You can access the GitHub <a href="https://github.com/fairDataSociety/beeson" title="BeeSon repo">here</a>.
image alt_text
/uploads/2022/10/04/dalle-2022-10-03-23-18-02.png
BeeSon
template block media_alignment headline content slug media
content-feature
feature-1
Right
Fair Data Improvement Proposals
The Fair Data Protocol improvement proposal (FIP) process is intended to provide a path for new specifications and features to be added to the Fair Data Protocol. This provides all the stakeholders with option to influence the direction of Fair Data Protocol evolution. The FIP process is described in the GitHub <a href="https://github.com/fairDataSociety/FIPs" title="FIPs repo">repo</a>.
image alt_text
/uploads/2022/10/04/dalle-2022-10-03-23-20-53.png
Fair Data Improvement Proposals
template block media_alignment headline media slug content
content-feature
feature-1
Right
bmt-js library
image alt_text
/uploads/2022/10/04/dalle-2022-10-03-23-26-24.png
bmt-js library
bmt-js is a JavaScript library that does Binary Merkle Tree (BMT) operations on data. The library calculates the content address of any data and also offers functions for performing cheap compact inclusion proof of any 32 bytes segments in it. You can access the GitHub documentation <a href="https://github.com/fairDataSociety/bmt-js" title="bmt-js library">here</a>. Watch the explainer <a href="https://youtu.be/LBt7dUVmgto" title="BMT explainer video">video</a>.
template block media_alignment headline slug content media
content-feature
feature-1
Left
Other Tools
<strong>FDP Contracts</strong><br>Contracts used in development, including BMT contracts and ENS contracts. <br><br><span style="text-decoration: underline;">BMT Contracts</span> - Swarm hashes can be verifiable on chain via Binary Merkle Trees. Fair Data Protocol has a full data function and coordinating JS library to support this. You can access the GitHub documentation<span class="Apple-converted-space"> </span><a href="https://github.com/fairDataSociety/bmt-js" title="">here</a>.<br><br><span style="text-decoration: underline;">ENS Contracts</span> - A reserved ENS name with an associated ETH address is used for Fair Data Protocol accounts. You can access the GitHub documentation<span class="Apple-converted-space"> </span><a href="https://github.com/fairDataSociety/fdp-contracts/tree/master/js-library" title="">here</a>.<br><br><strong>FDP Processor Library</strong><br>Beeson - A Blockchain-verifiable, extensible encapsulation for schema-based object notation in Swarm. You can access the GitHub documentation<span class="Apple-converted-space"> </span><a href="https://github.com/fairDataSociety/beeson" title="">here</a>.
image alt_text
/uploads/2022/06/11/markus-spiske-mgthz4zlc1u-unsplash.jpeg
Other tools
template block media_alignment headline media slug content
content-feature
feature-1
Right
Fair Data Protocol Roadmap
image alt_text
/uploads/2022/12/19/roadmap-milestones.png
Roadmap for FDP
The <a href="https://github.com/fairDataSociety/FIPs/blob/master/text/0001-fdp-roadmap.md" title="FDP Long Term Roadmap">long term roadmap for Fair Data Protocol</a> has been published as one of the first Fair Data Improvement proposals. The current state of milestones and next steps are described below.<br><br>I. Reviews with Protocolisation - the personal storage concept has been reviewed and refactored, the architecture <a href="https://github.com/fairDataSociety/FIPs/blob/master/text/0061-personal-storage.md" title="Personal Storage FIP"><span style="text-decoration: underline;">is documented</span></a> with its ongoing improvement ideas. <br><br>II. Registry Specifications - the User Store (ENS) smart contract is currently deployed on FDP-Play and Görli networks. <br><br>III. Authentication - The portable account feature is implemented in FDP Storage and Blossom that applications can integrate allowing to retrieve the user wallet by providing a username and a password. <br><br>IV. Authorization - The personal storage concept offers sharing PODs which are the sub-entities of the user for each application or used protocol. <br><br>V. Web3 services with Data Economics - Publishing the generic BMT inclusion proofs on BeeSon data in smart contracts is the next step when proof of storage requirements are met.<br><br>VI. Interoperability with integrations - With good experience with metadata-handling in the Swarm network but open to integrating other storage system solutions. Extensions can be proposed through the Fair Data Improvement proposals (FIPs).<br><br>The short term roadmap for next couple of months includes:<br>- deploying User store (ENS) smart contract to Ethereum mainnet,<br>- BeeSon generic inclusion proof smart contracts,<br>- refactoring and making packages more robust.
template block col_2 col_4 col_3 image_1 image_2 image_3 image_4 image
4-column-footer
footer-2
/uploads/2022/10/03/fds_logo_square_white-4x-80-cropped.jpg
/uploads/2022/10/03/github-mark-32px.png
/uploads/2022/10/03/discordpurple.svg
/uploads/2022/10/03/twitter.svg
template block link_1 image_1 image_spacer link_2 image_2 content
simple-footer
footer-1
/uploads/2022/10/03/fairdata.svg
/uploads/2022/10/04/blankspacer.png
/uploads/2022/10/03/swarm.svg