refactor: use the block API from ipfs instead of ipld internals #51
Conversation
This improves resusability of the module as it can be used by passing part of an `ipfs` or `ipfs-http-client` instance in. It also means we no longer double-serialize blocks before adding them which delivers a small but almost unperceptible performance increase. Finally also documents the `pin` and `preload` arguments.
|
|
||
| module.exports = (ipld) => { | ||
| // make ipld behave like the block api, some tests need to pull | ||
| // data from ipld so can't use use a simple hash |
There was a problem hiding this comment.
typo: "use use"
Also I don't really understand this comment :) What is a simple hash (a multihash instead of a CID?)?
There was a problem hiding this comment.
An overloaded term, sorry - hash as in hash table, not hash as in multihash. I've updated the comments.
| @@ -25,15 +25,15 @@ const defaultOptions = { | |||
| maxChildrenPerNode: 174, | |||
| layerRepeat: 4, | |||
| wrapWithDirectory: false, | |||
| pin: true, | |||
| pin: false, | |||
There was a problem hiding this comment.
I'm just double checking if that's intended or a left-over from debugging.
There was a problem hiding this comment.
Since we switched to the block API from the IPLD API, the pinning should be done by the caller after they are done importing, because you typically want the root CID pinned recursively (e.g. 1x pin), rather than each block pinned (e.g. potentially many pins).
|
|
||
| module.exports = (ipld) => { | ||
| // make ipld behave like the block api, some tests need to pull | ||
| // data from ipld so can't use use a simple hash |
There was a problem hiding this comment.
(same as for the exporter)
typo: "use use"
Also I don't really understand this comment :) What is a simple hash (a multihash instead of a CID?)?
This improves reusability of the module as it can be used by passing part of an
ipfsoripfs-http-clientinstance in.It also means we no longer double serialize blocks before adding them which delivers a very small performance increase (1-2%).
Finally also documents the
pinandpreloadarguments.BREAKING CHANGE:
The importer takes a
pinargument (previously undocumented) - it used to default totruebut since this switches to use the block API the default has changed tofalse, as the typical usage pattern is to pin the root block of a DAG recursively instead of every block that makes up the DAG.