From 8d2ddc29b7cfdc691acd85cdb031a017937f0c80 Mon Sep 17 00:00:00 2001 From: Alan Shaw Date: Mon, 28 Jun 2021 12:38:01 +0100 Subject: [PATCH 1/3] mpp: filecoin broker --- proposals/filecoin-broker.md | 50 ++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 proposals/filecoin-broker.md diff --git a/proposals/filecoin-broker.md b/proposals/filecoin-broker.md new file mode 100644 index 00000000..ad5f65fc --- /dev/null +++ b/proposals/filecoin-broker.md @@ -0,0 +1,50 @@ +# Filecoin Broker + +Authors: [@ribasushi](https://github.com/ribasushi) + + + + + +## What is the problem this project solves? +_Describe the status quo, including any relevant context on the problem you're seeing that this project should solve. Who is the user you're solving for, and why do they care about this problem? Wherever possible, include pain points or problems that you've seen users experience to help motivate why solving this problem works towards top-line objectives._ + +* Developers don't yet necessarily have the knowledge or ability to make deals with Filecoin miners. +* Filecoin miners currently favour large data which is not readily available to all clients who which to make deals. +* Clients do not always know which miners are accepting deals or are reputable. + +## Impact +_What goals/OKRs are being addressed (for w3dt, a specific program, etc.)? Why is this project important? What do we get with this project that we can't get without it?_ + +This is a key component that will be used to allow developers to get data stored on Filecoin (and later retrieved) within minimal knowledge of it's workings. + +## The idea +_Describe the proposed project solution, at a very high level. Stay at the level of the high-level requirements. Diagrams and interface descriptions can be useful, if you have any that help clarify and explain the idea._ + +* Automatically aggregate multiple sources of data and ensure it becomes stored with miners on the Filecoin network. +* Provide a way for miners who are interested in making deals to "self-serve" and be sent deals when they are willing to accept them. +* Maintain an queryable index of which miner is currently storing which data. +* Provide a means of retrieving data for a given CID from a miner who is known to store the data. + +## Success/acceptance criteria (optional) +_How do we know we're done with this project? How do we know we're successful? This field is OPTIONAL for the first draft of an MPP. Sometimes this field needs to be filled out once we have more detail on the shape of the actual solution._ + +## Detailed plans (optional) +_Link to more detailed project plans, e.g. product requirements documents (PRDs) and technical design docs, once they have been created for this project._ + +## Program (optional) +_If this project is part of a program, please indicate the relevant program here._ From 6c6b03c07c5a8b8b9572d1d8930e4172f72fe19d Mon Sep 17 00:00:00 2001 From: Peter Rabbitson Date: Mon, 28 Jun 2021 15:11:48 +0200 Subject: [PATCH 2/3] Fill in mention of dealflow and detailed design links --- proposals/filecoin-broker.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/proposals/filecoin-broker.md b/proposals/filecoin-broker.md index ad5f65fc..35d5f99c 100644 --- a/proposals/filecoin-broker.md +++ b/proposals/filecoin-broker.md @@ -1,6 +1,6 @@ # Filecoin Broker -Authors: [@ribasushi](https://github.com/ribasushi) +Authors: [@ribasushi](https://github.com/ribasushi) [@mikeal](https://github.com/mikeal) ## What is the problem this project solves? -_Describe the status quo, including any relevant context on the problem you're seeing that this project should solve. Who is the user you're solving for, and why do they care about this problem? Wherever possible, include pain points or problems that you've seen users experience to help motivate why solving this problem works towards top-line objectives._ +_Describe the status quo, including any relevant context on the problem you're seeing that this project should solve. Who is the user you're solving for, and why do they care about this problem? Wherever possible, include pain points or problems that you've seen users experience to help motivate why solving this problem works towards top-line objectives._ * Developers don't yet necessarily have the knowledge or ability to make deals with Filecoin miners. * Filecoin miners currently favour large data which is not readily available to all clients who which to make deals. @@ -35,8 +35,8 @@ This is a key component that will be used to allow developers to get data stored ## The idea _Describe the proposed project solution, at a very high level. Stay at the level of the high-level requirements. Diagrams and interface descriptions can be useful, if you have any that help clarify and explain the idea._ -* Automatically aggregate multiple sources of data and ensure it becomes stored with miners on the Filecoin network. -* Provide a way for miners who are interested in making deals to "self-serve" and be sent deals when they are willing to accept them. +* Continuously aggregate multiple sources of data and ensure it becomes stored with miners on the Filecoin network. +* Provide a way for miners who are interested in making deals to "self-serve" by downloading pre-packaged car files and then request an offline-deal-flow contract being issued against them at a time of their choosing. * Maintain an queryable index of which miner is currently storing which data. * Provide a means of retrieving data for a given CID from a miner who is known to store the data. @@ -44,7 +44,7 @@ _Describe the proposed project solution, at a very high level. Stay at the level _How do we know we're done with this project? How do we know we're successful? This field is OPTIONAL for the first draft of an MPP. Sometimes this field needs to be filled out once we have more detail on the shape of the actual solution._ ## Detailed plans (optional) -_Link to more detailed project plans, e.g. product requirements documents (PRDs) and technical design docs, once they have been created for this project._ +Refer to https://hackmd.io/8DOUz0ybT3-ipxfdhN6JIQ for design of the pipeline and to https://hackmd.io/O-zleFXsTdKNIyUZ-3bDDw for the proto-spec of the deal-packing itself (full spec coming in the next few days to the docsection of https://pkg.go.dev/github.com/filecoin-project/go-dagaggregator-unixfs ) ## Program (optional) _If this project is part of a program, please indicate the relevant program here._ From 801772b5bac70a0a11e4f61a27c6914c04e59402 Mon Sep 17 00:00:00 2001 From: Peter Rabbitson Date: Mon, 28 Jun 2021 15:13:44 +0200 Subject: [PATCH 3/3] Fix viewlinks --- proposals/filecoin-broker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposals/filecoin-broker.md b/proposals/filecoin-broker.md index 35d5f99c..7c1585e2 100644 --- a/proposals/filecoin-broker.md +++ b/proposals/filecoin-broker.md @@ -44,7 +44,7 @@ _Describe the proposed project solution, at a very high level. Stay at the level _How do we know we're done with this project? How do we know we're successful? This field is OPTIONAL for the first draft of an MPP. Sometimes this field needs to be filled out once we have more detail on the shape of the actual solution._ ## Detailed plans (optional) -Refer to https://hackmd.io/8DOUz0ybT3-ipxfdhN6JIQ for design of the pipeline and to https://hackmd.io/O-zleFXsTdKNIyUZ-3bDDw for the proto-spec of the deal-packing itself (full spec coming in the next few days to the docsection of https://pkg.go.dev/github.com/filecoin-project/go-dagaggregator-unixfs ) +Refer to https://hackmd.io/8DOUz0ybT3-ipxfdhN6JIQ?view for design of the pipeline and to https://hackmd.io/O-zleFXsTdKNIyUZ-3bDDw?view for the proto-spec of the deal-packing itself (full spec coming in the next few days to the docsection of https://pkg.go.dev/github.com/filecoin-project/go-dagaggregator-unixfs ) ## Program (optional) _If this project is part of a program, please indicate the relevant program here._