Adds endpoint for proposing a storage deal #68

hazmatzo · 2019-08-07T21:09:15Z

Adds the ability to propose a storage deal

Issue #15

Endpoint
/api/client/propose-storage-deal

Description
Propose a storage deal with a storage miner

Arguments

arg [string]: Address of miner to send storage proposal Required: yes.
arg [string]: CID of the data to be stored Required: yes.
arg [string]: ID of ask for which to propose a deal Required: yes.
arg [string]: Time in blocks (about 30 seconds per block) to store data Required: yes.
allow-duplicates [bool]: Allows duplicate proposals to be created. Unless this flag is set, you will not be able to make more than one deal per piece per miner. This protection exists to prevent erroneous duplicate deals. Required: no.

Response
On success, the call to this endpoint will return with 200 and the following body:

{
  "State":7,
  "Message":"",
  "ProposalCid":
    {
      "/":"zDPWYqFD8CNXu7Mo9qPSUANbTK2vi9vJBnvavF9S1pVGPHafVHpT"
    },
  "ProofInfo":
    {
      "SectorID":1,
      "CommitmentMessage":
        {
          "/":"zDPWYqFCtHkWNkE2p6t6TeV1sPP5kbnKc5ajUhMVV8xvrw1u5F1R"
        },
      "PieceInclusionProof":"EiAbbOy4pChsCYqFYA6qJaUJYStlnwYMdQPHZX7YBkVXDD6vgmGTPnWrcdA9M0oAXQCzOq735YKySLUoTI6pAw=="
    },
  "Signature":"c2lnbmF0dXJycmVlZQ=="
}

resolves #15

hazmatzo · 2019-08-07T21:20:15Z

API.md

+  "Signature":"c2lnbmF0dXJycmVlZQ=="
+}
+*/
+```


This is what I got back locally when I ran it. This somewhat differs from what I expected, honestly, but I represented what is currently returning from go-filecoin.

hazmatzo · 2019-08-07T21:22:56Z

API.md

+const storageDealProposal = await fc.client.proposeStorageDeal(miner, cid, askId, time, { allowDuplicates: true })
+
+// with allow duplicates flag and options, order important
+const storageDealProposal = await fc.client.proposeStorageDeal(miner, cid, askId, time, { allowDuplicates: true }, { signal: "some signal to abort" })


This is my proposal for how to handle all the arguments and also options on our end. If you use the go-filecoin command line, it ends up being and optional flag like so: --allow-duplicates. If you'd like a different interface, let me know.

In existing endpoints both options are bundled together e.g. { allowDuplicates, signal }. I think this is best for simplicity (and consistency) and we'll deal with a collision if/when it happens.

hazmatzo · 2019-08-07T21:23:53Z

@alanshaw This is the propose storage deal one, let me know if you have questions.

alanshaw · 2019-08-09T13:13:50Z

API.md

+| cid | `String` | CID of the data to be stored |
+| id | `String` | ID of ask for which to propose a deal |
+| time | `String` | Time in blocks (about 30 seconds per block) to store data. For example, storing for 1 day (2 blocks/min * 60 min/hr * 24 hr/day) = 2880 blocks. |
+| allowDuplicates | `Boolean` | Allows duplicate proposals to be created. Unless this flag is set, you will not be able to make more than one deal per piece per miner. This protection exists to prevent erroneous duplicate deals. This parameter is not required. |


This should be options.allowDuplicates

Great! Thanks for the clarifying.

alanshaw · 2019-08-09T13:15:56Z

API.md

+const storageDealProposal = await fc.client.proposeStorageDeal(miner, cid, askId, time, { allowDuplicates: true })
+
+// with allow duplicates flag and options, order important
+const storageDealProposal = await fc.client.proposeStorageDeal(miner, cid, askId, time, { allowDuplicates: true }, { signal: "some signal to abort" })


In existing endpoints both options are bundled together e.g. { allowDuplicates, signal }. I think this is best for simplicity (and consistency) and we'll deal with a collision if/when it happens.

alanshaw · 2019-08-09T13:16:51Z

API.md

+    },
+  "ProofInfo":null,
+  "Signature":"c2lnbmF0dXJycmVlZQ=="
+}


Please use toCamel utility on this response to be more idiomatic for JS users.

alanshaw · 2019-08-09T13:17:41Z

src/cmd/client/propose-storage-deal.js

+
+    const duplicatesParam = allowDuplicates ? `&allow-duplicates=${encodeURIComponent(allowDuplicates)}` : ""
+
+    const url = `${toUri(config.apiAddr)}/api/client/proposeStorageDeal?arg=${miner}&arg=${cid}&arg${askId}&arg${time}${duplicatesParam}`


Use the querystring module to stringify an object when multiple params. Please check other endpoints for examples.

* /api/client/propose-storage-deal Propose a storage deal with a storage miner Arguments * arg [string]: Address of miner to send storage proposal Required: yes. * arg [string]: CID of the data to be stored Required: yes. * arg [string]: ID of ask for which to propose a deal Required: yes. * arg [string]: Time in blocks (about 30 seconds per block) to store data Required: yes. * allow-duplicates [bool]: Allows duplicate proposals to be created. Unless this flag is set, you will not be able to make more than one deal per piece per miner. This protection exists to prevent erroneous duplicate deals. Required: no. Response On success, the call to this endpoint will return with 200 and the following body: { "State":7, "Message":"", "ProposalCid": { "/":"zDPWYqFD8CNXu7Mo9qPSUANbTK2vi9vJBnvavF9S1pVGPHafVHpT" }, "ProofInfo": { "SectorID":1, "CommitmentMessage": { "/":"zDPWYqFCtHkWNkE2p6t6TeV1sPP5kbnKc5ajUhMVV8xvrw1u5F1R" }, "PieceInclusionProof":"EiAbbOy4pChsCYqFYA6qJaUJYStlnwYMdQPHZX7YBkVXDD6vgmGTPnWrcdA9M0oAXQCzOq735YKySLUoTI6pAw==" }, "Signature":"c2lnbmF0dXJycmVlZQ==" }

* The thought here being this is more idiomatic for JS users * Updates params with querystring

hazmatzo · 2019-08-09T22:39:42Z

@alanshaw

Updated! Let me know if there's anything else.

hazmatzo force-pushed the api/client/propose-storage-deal branch 2 times, most recently from 8ea3833 to 365df8b Compare August 7, 2019 21:18

hazmatzo commented Aug 7, 2019

View reviewed changes

mishmosh requested a review from alanshaw August 7, 2019 21:27

alanshaw suggested changes Aug 9, 2019

View reviewed changes

hazmatzo added 2 commits August 9, 2019 13:56

Adjusts API to now include allowDuplicates as part of the options

87030b5

hazmatzo force-pushed the api/client/propose-storage-deal branch 2 times, most recently from b60479e to e69f5d8 Compare August 9, 2019 21:35

Modifies storage deal response to be camelCase

6628693

* The thought here being this is more idiomatic for JS users * Updates params with querystring

hazmatzo force-pushed the api/client/propose-storage-deal branch from bb3fd7b to 6628693 Compare August 9, 2019 22:37

fix: tweaks and fixes

0c1bbbe

alanshaw approved these changes Aug 10, 2019

View reviewed changes

alanshaw merged commit 3826029 into filecoin-shipyard:master Aug 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds endpoint for proposing a storage deal #68

Adds endpoint for proposing a storage deal #68

hazmatzo commented Aug 7, 2019 •

edited by alanshaw

Loading

hazmatzo Aug 7, 2019

hazmatzo Aug 7, 2019

alanshaw Aug 9, 2019

hazmatzo commented Aug 7, 2019

alanshaw Aug 9, 2019

hazmatzo Aug 9, 2019 •

edited

Loading

alanshaw Aug 9, 2019

alanshaw Aug 9, 2019

alanshaw Aug 9, 2019

hazmatzo commented Aug 9, 2019


		const duplicatesParam = allowDuplicates ? `&allow-duplicates=${encodeURIComponent(allowDuplicates)}` : ""

		const url = `${toUri(config.apiAddr)}/api/client/proposeStorageDeal?arg=${miner}&arg=${cid}&arg${askId}&arg${time}${duplicatesParam}`

Adds endpoint for proposing a storage deal #68

Adds endpoint for proposing a storage deal #68

Conversation

hazmatzo commented Aug 7, 2019 • edited by alanshaw Loading

hazmatzo Aug 7, 2019

Choose a reason for hiding this comment

hazmatzo Aug 7, 2019

Choose a reason for hiding this comment

alanshaw Aug 9, 2019

Choose a reason for hiding this comment

hazmatzo commented Aug 7, 2019

alanshaw Aug 9, 2019

Choose a reason for hiding this comment

hazmatzo Aug 9, 2019 • edited Loading

Choose a reason for hiding this comment

alanshaw Aug 9, 2019

Choose a reason for hiding this comment

alanshaw Aug 9, 2019

Choose a reason for hiding this comment

alanshaw Aug 9, 2019

Choose a reason for hiding this comment

hazmatzo commented Aug 9, 2019

hazmatzo commented Aug 7, 2019 •

edited by alanshaw

Loading

hazmatzo Aug 9, 2019 •

edited

Loading