Changes the API to be camelcase

* In order to be more idiomatic for JavaScript
* Modified the incoming proposalCid, which was historically encoded in IPLD

Author: hazmatzo

API.md

@@ -495,6 +495,7 @@ const storageDealProposal = await fc.client.proposeStorageDeal(miner, cid, askId
 ## `client.queryStorageDeal`
 
 > Query a storage deal's status
+
 ### `client.queryStorageDeal(dealCid, [options])`
 
 #### Parameters
@@ -520,22 +521,19 @@ console.log(storageDeal)
 
 /*
 {
-  "State":7,
-  "Message":"",
-  "ProposalCid":
-    {
-      "/":"zDPWYqFD8CNXu7Mo9qPSUANbTK2vi9vJBnvavF9S1pVGPHafVHpT"
-    },
-  "ProofInfo":
+  "state": 7,
+  "message": "",
+  "proposalCid": "zDPWYqFD8CNXu7Mo9qPSUANbTK2vi9vJBnvavF9S1pVGPHafVHpT",
+  "proofInfo":
     {
-      "SectorID":1,
-      "CommitmentMessage":
+      "sectorID": 1,
+      "commitmentMessage":
         {
-          "/":"zDPWYqFCtHkWNkE2p6t6TeV1sPP5kbnKc5ajUhMVV8xvrw1u5F1R"
+          "/":  "zDPWYqFCtHkWNkE2p6t6TeV1sPP5kbnKc5ajUhMVV8xvrw1u5F1R"
         },
-      "PieceInclusionProof":"EiAbbOy4pChsCYqFYA6qJaUJYStlnwYMdQPHZX7YBkVXDD6vgmGTPnWrcdA9M0oAXQCzOq735YKySLUoTI6pAw=="
+      "pieceInclusionProof":  "EiAbbOy4pChsCYqFYA6qJaUJYStlnwYMdQPHZX7YBkVXDD6vgmGTPnWrcdA9M0oAXQCzOq735YKySLUoTI6pAw=="
     },
-  "Signature":"c2lnbmF0dXJycmVlZQ=="
+  "signature": "c2lnbmF0dXJycmVlZQ=="
 }
 */
 ```

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

@@ -1,5 +1,6 @@
 const toUri = require('../../lib/multiaddr-to-uri')
 const { ok } = require('../../lib/fetch')
+const toCamel = require('../../lib/to-camel')
 
 module.exports = (fetch, config) => {
   return async (cid, options) => {
@@ -8,7 +9,16 @@ module.exports = (fetch, config) => {
     const url = `${toUri(config.apiAddr)}/api/client/query-storage-deal?arg=${encodeURIComponent(cid)}`
     const res = await ok(fetch(url, { signal: options.signal }))
 
-    const data = await res.json()
-    return data
+    const storageDeal = toCamel(await res.json())
+
+    if (storageDeal.proposalCid) {
+      storageDeal.proposalCid = storageDeal.proposalCid['/']
+    }
+
+    if (storageDeal.proofInfo) {
+      storageDeal.proofInfo = toCamel(storageDeal.proofInfo)
+    }
+
+    return storageDeal
   }
 }

test/unit/cmd/client/query-storage-deal.fixtures.json

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

test/unit/cmd/client/query-storage-deal.test.js

@@ -1,31 +1,29 @@
 const test = require('ava')
 const Filecoin = require('../../../../src')
+const Fixtures = require('./query-storage-deal.fixtures.json')
 
 test('should list the storage deal info for a particular cid', async t => {
   const cid = "zDPWYqFCuTNxiwRkt1iDJWEy6qKPGCunMGHrP1ojsMrZDWKYsgzF"
-  const storageDeal = {
-    "State":7,
-    "Message":"",
-    "ProposalCid":
-      {
-        "/":"zDPWYqFD8CNXu7Mo9qPSUANbTK2vi9vJBnvavF9S1pVGPHafVHpT"
-      },
-    "ProofInfo":
-      {
-        "SectorID":1,
-        "CommitmentMessage":
-          {
-            "/":"zDPWYqFCtHkWNkE2p6t6TeV1sPP5kbnKc5ajUhMVV8xvrw1u5F1R"
-          },
-        "PieceInclusionProof":"EiAbbOy4pChsCYqFYA6qJaUJYStlnwYMdQPHZX7YBkVXDD6vgmGTPnWrcdA9M0oAXQCzOq735YKySLUoTI6pAw=="
-      },
-    "Signature":"c2lnbmF0dXJycmVlZQ=="
-  }
 
-  const fetch = () => ({ ok: true, json: () => storageDeal })
+  const fetch = () => ({ ok: true, json: () => Fixtures })
   const fc = Filecoin(fetch)
 
   const res = await fc.client.queryStorageDeal(cid)
 
-  t.is(storageDeal, res)
+  const proofInfo = {
+    "sectorID": 1,
+    "commitmentMessage":
+      {
+        "/": "zDPWYqFCtHkWNkE2p6t6TeV1sPP5kbnKc5ajUhMVV8xvrw1u5F1R"
+      },
+    "pieceInclusionProof": "EiAbbOy4pChsCYqFYA6qJaUJYStlnwYMdQPHZX7YBkVXDD6vgmGTPnWrcdA9M0oAXQCzOq735YKySLUoTI6pAw=="
+  }
+
+  t.deepEqual(res, {
+    state: 7,
+    message: '',
+    proposalCid: 'zDPWYqFD8CNXu7Mo9qPSUANbTK2vi9vJBnvavF9S1pVGPHafVHpT',
+    proofInfo: proofInfo,
+    signature: 'c2lnbmF0dXJycmVlZQ=='
+  })
 })