Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit 38bed14

Browse files
author
Alan Shaw
authored
refactor: object API write methods now return CIDs (#896)
BREAKING CHANGE: Object API refactor. Object API methods that write DAG nodes now return a CID instead of a DAG node. Affected methods: * `ipfs.object.new` * `ipfs.object.patch.addLink` * `ipfs.object.patch.appendData` * `ipfs.object.patch.rmLink` * `ipfs.object.patch.setData` * `ipfs.object.put` Example: ```js // Before const dagNode = await ipfs.object.new() ``` ```js // After const cid = await ipfs.object.new() // now returns a CID const dagNode = await ipfs.object.get(cid) // fetch the DAG node that was created ``` IMPORTANT: `DAGNode` instances, which are part of the IPLD dag-pb format have been refactored. These instances no longer have `multihash`, `cid` or `serialized` properties. This effects the following API methods that return these types of objects: * `ipfs.object.get` * `ipfs.dag.get` See ipld/js-ipld-dag-pb#99 for more information. License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
1 parent 315b7f7 commit 38bed14

File tree

9 files changed

+17
-86
lines changed

9 files changed

+17
-86
lines changed

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
"lodash": "^4.17.11",
5050
"lru-cache": "^4.1.3",
5151
"multiaddr": "^5.0.2",
52-
"multibase": "~0.5.0",
52+
"multibase": "~0.6.0",
5353
"multihashes": "~0.4.14",
5454
"ndjson": "^1.5.0",
5555
"once": "^1.4.0",
@@ -85,7 +85,7 @@
8585
"eslint-plugin-react": "^7.11.1",
8686
"go-ipfs-dep": "~0.4.18",
8787
"gulp": "^3.9.1",
88-
"interface-ipfs-core": "~0.87.0",
88+
"interface-ipfs-core": "~0.88.0",
8989
"ipfsd-ctl": "~0.40.0",
9090
"nock": "^10.0.2",
9191
"pull-stream": "^3.6.9",

‎src/object/addLink.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
'use strict'
22

33
const promisify = require('promisify-es6')
4+
const CID = require('cids')
45
const cleanMultihash = require('../utils/clean-multihash')
56

67
module.exports = (send) => {
7-
const objectGet = require('./get')(send)
8-
98
return promisify((multihash, dLink, opts, callback) => {
109
if (typeof opts === 'function') {
1110
callback = opts
@@ -32,7 +31,7 @@ module.exports = (send) => {
3231
if (err) {
3332
return callback(err)
3433
}
35-
objectGet(result.Hash, { enc: 'base58' }, callback)
34+
callback(null, new CID(result.Hash))
3635
})
3736
})
3837
}

‎src/object/appendData.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
const promisify = require('promisify-es6')
44
const once = require('once')
5+
const CID = require('cids')
56
const cleanMultihash = require('../utils/clean-multihash')
67
const SendOneFile = require('../utils/send-one-file')
78

89
module.exports = (send) => {
9-
const objectGet = require('./get')(send)
1010
const sendOneFile = SendOneFile(send, 'object/patch/append-data')
1111

1212
return promisify((multihash, data, opts, _callback) => {
@@ -30,7 +30,7 @@ module.exports = (send) => {
3030
return callback(err)
3131
}
3232

33-
objectGet(result.Hash, { enc: 'base58' }, callback)
33+
callback(null, new CID(result.Hash))
3434
})
3535
})
3636
}

‎src/object/links.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ const promisify = require('promisify-es6')
44
const dagPB = require('ipld-dag-pb')
55
const DAGLink = dagPB.DAGLink
66
const cleanMultihash = require('../utils/clean-multihash')
7-
const bs58 = require('bs58')
87
const LRU = require('lru-cache')
98
const lruOptions = {
109
max: 128
@@ -46,7 +45,7 @@ module.exports = (send) => {
4645

4746
if (result.Links) {
4847
links = result.Links.map((l) => {
49-
return new DAGLink(l.Name, l.Size, Buffer.from(bs58.decode(l.Hash)))
48+
return new DAGLink(l.Name, l.Size, l.Hash)
5049
})
5150
}
5251
callback(null, links)

‎src/object/new.js‎

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
'use strict'
22

33
const promisify = require('promisify-es6')
4-
const dagPB = require('ipld-dag-pb')
5-
const DAGNode = dagPB.DAGNode
6-
const Unixfs = require('ipfs-unixfs')
4+
const CID = require('cids')
75

86
module.exports = (send) => {
97
return promisify((template, callback) => {
@@ -19,24 +17,7 @@ module.exports = (send) => {
1917
return callback(err)
2018
}
2119

22-
let data
23-
24-
if (template) {
25-
if (template !== 'unixfs-dir') {
26-
return callback(new Error('unkown template: ' + template))
27-
}
28-
data = (new Unixfs('directory')).marshal()
29-
} else {
30-
data = Buffer.alloc(0)
31-
}
32-
33-
DAGNode.create(data, (err, node) => {
34-
if (err) {
35-
return callback(err)
36-
}
37-
38-
callback(null, node)
39-
})
20+
callback(null, new CID(result.Hash))
4021
})
4122
})
4223
}

‎src/object/put.js‎

Lines changed: 3 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
'use strict'
22

33
const promisify = require('promisify-es6')
4-
const dagPB = require('ipld-dag-pb')
5-
const DAGNode = dagPB.DAGNode
6-
const LRU = require('lru-cache')
7-
const lruOptions = {
8-
max: 128
9-
}
4+
const CID = require('cids')
5+
const { DAGNode } = require('ipld-dag-pb')
106

11-
const cache = LRU(lruOptions)
127
const SendOneFile = require('../utils/send-one-file')
138
const once = require('once')
149

@@ -72,49 +67,7 @@ module.exports = (send) => {
7267
return callback(err) // early
7368
}
7469

75-
if (Buffer.isBuffer(obj)) {
76-
if (!options.enc) {
77-
obj = { Data: obj, Links: [] }
78-
} else if (options.enc === 'json') {
79-
obj = JSON.parse(obj.toString())
80-
}
81-
}
82-
83-
let node
84-
85-
if (DAGNode.isDAGNode(obj)) {
86-
node = obj
87-
} else if (options.enc === 'protobuf') {
88-
dagPB.util.deserialize(obj, (err, _node) => {
89-
if (err) {
90-
return callback(err)
91-
}
92-
node = _node
93-
next()
94-
})
95-
return
96-
} else {
97-
DAGNode.create(Buffer.from(obj.Data), obj.Links, (err, _node) => {
98-
if (err) {
99-
return callback(err)
100-
}
101-
node = _node
102-
next()
103-
})
104-
return
105-
}
106-
next()
107-
108-
function next () {
109-
dagPB.util.cid(node, (err, cid) => {
110-
if (err) {
111-
return callback(err)
112-
}
113-
114-
cache.set(cid.toBaseEncodedString(), node)
115-
callback(null, node)
116-
})
117-
}
70+
callback(null, new CID(result.Hash))
11871
})
11972
})
12073
}

‎src/object/rmLink.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
'use strict'
22

33
const promisify = require('promisify-es6')
4+
const CID = require('cids')
45
const cleanMultihash = require('../utils/clean-multihash')
56

67
module.exports = (send) => {
7-
const objectGet = require('./get')(send)
8-
98
return promisify((multihash, dLink, opts, callback) => {
109
if (typeof opts === 'function') {
1110
callback = opts
@@ -31,7 +30,7 @@ module.exports = (send) => {
3130
if (err) {
3231
return callback(err)
3332
}
34-
objectGet(result.Hash, { enc: 'base58' }, callback)
33+
callback(null, new CID(result.Hash))
3534
})
3635
})
3736
}

‎src/object/setData.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
const promisify = require('promisify-es6')
44
const once = require('once')
5+
const CID = require('cids')
56
const cleanMultihash = require('../utils/clean-multihash')
67
const SendOneFile = require('../utils/send-one-file')
78

89
module.exports = (send) => {
9-
const objectGet = require('./get')(send)
1010
const sendOneFile = SendOneFile(send, 'object/patch/set-data')
1111

1212
return promisify((multihash, data, opts, _callback) => {
@@ -29,7 +29,7 @@ module.exports = (send) => {
2929
if (err) {
3030
return callback(err)
3131
}
32-
objectGet(result.Hash, { enc: 'base58' }, callback)
32+
callback(null, new CID(result.Hash))
3333
})
3434
})
3535
}

‎test/log.spec.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ describe('.log', function () {
3232

3333
it('.log.tail', (done) => {
3434
let i = setInterval(() => {
35-
ipfs.files.add(Buffer.from('just adding some data to generate logs'))
35+
ipfs.add(Buffer.from('just adding some data to generate logs'))
3636
}, 1000)
3737

3838
const req = ipfs.log.tail((err, res) => {

0 commit comments

Comments
 (0)