docs: w3filecoin feedback changes #75

alanshaw · 2023-08-17T13:58:22Z

I was going to submit an issue but then I decided it might be quicker to send a PR.

alanshaw · 2023-08-17T13:59:05Z

w3-filecoin.md

-| Aggregator    | [Principal] identified by `did:key` identifier, representing a storage aggregator like w3filecoin |
-| Dealer        | [Principal] identified by `did:key` identifier that arranges filecoin deals with storage providers. e.g. Spade |
-| Chain Tracker | [Principal] identified by `did:key` identifier that tracks the filecoin chain |
+| Storefront    | [Principal] identified by a DID, representing a storage API like web3.storage |


What is the reason for specifying the DID method as well in the spec? Is it not enough to say "a DID"?

Good point, I don't think we need to captured our implementation details in the spec.

alanshaw · 2023-08-17T13:59:35Z

w3-filecoin.md

+| Storefront    | [Principal] identified by a DID, representing a storage API like web3.storage |
+| Aggregator    | [Principal] identified by a DID, representing a storage aggregator like w3filecoin |
+| Dealer        | [Principal] identified by a DID, that arranges filecoin deals with storage providers. e.g. Spade |
+| Deal Tracker  | [Principal] identified by a DID, that tracks deals made by the Dealer |


I think this was suggested previously but why not "Deal Tracker"? Lots of things are stored on chain, but we're only interested in the deals. Also blockchain is an artefact of the chosen storage system - maybe in the future we might make deals for storage providers that don't operate on a blockchain?!

I agree and I think deal tracker is a better name. I think "deal monitor" maybe even better one.

I think this makes sense. I have actually been calling it Deal Tracker for the project. I think monitoring might create confusion with the monitoring/alerting stuff for SLA, so here I would stick to "Deal Tracker"

w3-filecoin.md

alanshaw · 2023-08-17T14:01:11Z

w3-filecoin.md


 # Protocol

 ## Overview

-A Storefront is web2 to web3 bridge. It ingests user/application data through a conventional web2 interface and replicates it across various storage systems, including Filecoin Storage Providers. Content supplied to a Storefront can be of arbitrary size, while (Filecoin) Storage Providers demand large (>= 16GiB) content pieces.  To align supply and demand requirements, the aggregator accumulates supplied content pieces into a larger verifiable aggregate pieces per [FRC-0058](https://github.com/filecoin-project/FIPs/blob/master/FRCs/frc-0058.md) that can be stored by Storage Providers.
+A Storefront is a service that ensures content addressed user/application data is stored perpetually on the decentralized web. A Storefront ingests user/application data and replicates it across various storage systems, including Filecoin Storage Providers. Content supplied to a Storefront can be of arbitrary size, while (Filecoin) Storage Providers demand large (>= 16GiB) content pieces.  To align supply and demand requirements, the aggregator accumulates supplied content pieces into a larger verifiable aggregate pieces per [FRC-0058](https://github.com/filecoin-project/FIPs/blob/master/FRCs/frc-0058.md) that can be stored by Storage Providers.


Do we need to say "web2 to web3 bridge"?

I think proposed version reads better.

Gozala · 2023-08-28T18:39:13Z

w3-filecoin.md

-| Aggregator    | [Principal] identified by `did:key` identifier, representing a storage aggregator like w3filecoin |
-| Dealer        | [Principal] identified by `did:key` identifier that arranges filecoin deals with storage providers. e.g. Spade |
-| Chain Tracker | [Principal] identified by `did:key` identifier that tracks the filecoin chain |
+| Storefront    | [Principal] identified by a DID, representing a storage API like web3.storage |


Good point, I don't think we need to captured our implementation details in the spec.

Gozala · 2023-08-28T18:41:34Z

w3-filecoin.md

+| Storefront    | [Principal] identified by a DID, representing a storage API like web3.storage |
+| Aggregator    | [Principal] identified by a DID, representing a storage aggregator like w3filecoin |
+| Dealer        | [Principal] identified by a DID, that arranges filecoin deals with storage providers. e.g. Spade |
+| Deal Tracker  | [Principal] identified by a DID, that tracks deals made by the Dealer |


I agree and I think deal tracker is a better name. I think "deal monitor" maybe even better one.

w3-filecoin.md

Gozala · 2023-08-28T18:47:46Z

w3-filecoin.md


 A Storefront facilitates data storage services to applications and users, getting the requested data stored into Filecoin deals asynchronously.

 ### Aggregator

-An _Aggregator_ is a type of [principal] identified by a `did:key` identifier.
+An _Aggregator_ is a type of [principal] identified by a DID (typically a `did:key` identifier).


Suggested change

An _Aggregator_ is a type of [principal] identified by a DID (typically a `did:key` identifier).

An _Aggregator_ is a type of [principal] identified by a DID. It is RECOMMENDED to use use [`did:key`] identifier as due to their stateless nature.

Gozala · 2023-08-28T18:50:32Z

w3-filecoin.md


 # Protocol

 ## Overview

-A Storefront is web2 to web3 bridge. It ingests user/application data through a conventional web2 interface and replicates it across various storage systems, including Filecoin Storage Providers. Content supplied to a Storefront can be of arbitrary size, while (Filecoin) Storage Providers demand large (>= 16GiB) content pieces.  To align supply and demand requirements, the aggregator accumulates supplied content pieces into a larger verifiable aggregate pieces per [FRC-0058](https://github.com/filecoin-project/FIPs/blob/master/FRCs/frc-0058.md) that can be stored by Storage Providers.
+A Storefront is a service that ensures content addressed user/application data is stored perpetually on the decentralized web. A Storefront ingests user/application data and replicates it across various storage systems, including Filecoin Storage Providers. Content supplied to a Storefront can be of arbitrary size, while (Filecoin) Storage Providers demand large (>= 16GiB) content pieces.  To align supply and demand requirements, the aggregator accumulates supplied content pieces into a larger verifiable aggregate pieces per [FRC-0058](https://github.com/filecoin-project/FIPs/blob/master/FRCs/frc-0058.md) that can be stored by Storage Providers.


I think proposed version reads better.

vasco-santos

All the changes look good to me! This PR will need to be rebased to get the new capabilities separation from queue and enqueue separation

vasco-santos · 2023-08-29T15:09:48Z

w3-filecoin.md

+| Storefront    | [Principal] identified by a DID, representing a storage API like web3.storage |
+| Aggregator    | [Principal] identified by a DID, representing a storage aggregator like w3filecoin |
+| Dealer        | [Principal] identified by a DID, that arranges filecoin deals with storage providers. e.g. Spade |
+| Deal Tracker  | [Principal] identified by a DID, that tracks deals made by the Dealer |


I think this makes sense. I have actually been calling it Deal Tracker for the project. I think monitoring might create confusion with the monitoring/alerting stuff for SLA, so here I would stick to "Deal Tracker"

alanshaw · 2023-09-13T15:58:45Z

I also added a ToC because it is a big one.

vasco-santos

LGTM

alanshaw requested review from travis, Gozala, olizilla and vasco-santos August 17, 2023 13:58

alanshaw commented Aug 17, 2023

View reviewed changes

Gozala reviewed Aug 28, 2023

View reviewed changes

vasco-santos requested changes Aug 29, 2023

View reviewed changes

docs: w3filecoin feedback changes

e12e0eb

alanshaw force-pushed the w3fil-feedback branch from b5e8f04 to e12e0eb Compare September 13, 2023 15:25

Alan Shaw added 7 commits September 13, 2023 16:29

chore: appease linter

35578c6

chore: appease linter

e40a9ef

feat: add ToC

59831de

docs: add missing toc item

25fb632

chore: appease linter

da73a4e

chore: omg leave me alone

e8b5f32

chore: remove missing schema link

6d73237

vasco-santos approved these changes Sep 14, 2023

View reviewed changes

alanshaw merged commit 195f318 into main Sep 14, 2023
2 checks passed

alanshaw deleted the w3fil-feedback branch September 14, 2023 06:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: w3filecoin feedback changes #75

docs: w3filecoin feedback changes #75

alanshaw commented Aug 17, 2023

alanshaw Aug 17, 2023

Gozala Aug 28, 2023

alanshaw Aug 17, 2023

Gozala Aug 28, 2023

vasco-santos Aug 29, 2023

alanshaw Aug 17, 2023

Gozala Aug 28, 2023

Gozala Aug 28, 2023

Gozala Aug 28, 2023

Gozala Aug 28, 2023

Gozala Aug 28, 2023

vasco-santos left a comment

vasco-santos Aug 29, 2023

alanshaw commented Sep 13, 2023

vasco-santos left a comment

	An _Aggregator_ is a type of [principal] identified by a DID (typically a `did:key` identifier).
	An _Aggregator_ is a type of [principal] identified by a DID. It is RECOMMENDED to use use [`did:key`] identifier as due to their stateless nature.

docs: w3filecoin feedback changes #75

docs: w3filecoin feedback changes #75

Conversation

alanshaw commented Aug 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vasco-santos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alanshaw commented Sep 13, 2023

vasco-santos left a comment

Choose a reason for hiding this comment