[WIP] chore: update IPLD to latest version #1652
Conversation
alanshaw
changed the title
ghost
assigned 
It is now possible to pass in options for IPLD. This makes it possible
to pass in the formats that IPFS should support.
With version 0.19.0 of js-ipld the default formats are *only* [dag-cbor]
and [dag-pb].
BREAKING CHANGE: js-ipfs supports dag-cbor and dag-pb by default only
If you use js-ipfs as a library, only [dag-cbor] and [dag-pb] are bundled
by default. If you want to use additional formats, you need to pass them
into the constructor.
This example code shows how to get the same behaviour as before:
```js
const ipldBitcoin = require('ipld-bitcoin')
const ipldDagCbor = require('ipld-dag-cbor')
const ipldDagPb = require('ipld-dag-pb')
const ipldEthAccountSnapshot = require('ipld-ethereum').ethAccountSnapshot
const ipldEthBlock = require('ipld-ethereum').ethBlock
const ipldEthBlockList = require('ipld-ethereum').ethBlockList
const ipldEthStateTrie = require('ipld-ethereum').ethStateTrie
const ipldEthStorageTrie = require('ipld-ethereum').ethStorageTrie
const ipldEthTrie = require('ipld-ethereum').ethTxTrie
const ipldEthTx = require('ipld-ethereum').ethTx
const ipldGit = require('ipld-git')
const ipldRaw = require('ipld-raw')
const ipldZcash = require('ipld-zcash')
const node = new IPFS({
ipld: {
formats: [
ipldBitcoin, ipldDagCbor, ipldDagPb, ipldEthAccountSnapshot,
ipldEthBlock, ipldEthBlockList, ipldEthStateTrie, ipldEthStorageTrie,
ipldEthTrie, ipldEthTx, ipldGit, ipldRaw, ipldZcash
]
}
})
```
There is no change on the js-ipfs command line tool, it still supports
all those formats.
[dag-cbor]: https://github.com/ipld/js-ipld-dag-cbor
[dag-pb]: https://github.com/ipld/js-ipld-dag-pp
|
I've checked the examples (the only one I couldn't get working was the circuit one, but after looking at the code, it should be affected by my changes), they work, resp. I made them work. |
|
WARNING: This is not ready to be merged (even if CI is green). This needs a new js-ipld release first. |
| } else if (this._options.ipld.blockService === undefined) { | ||
| this._options.ipld.blockService = ipldDefaults.blockService | ||
| } | ||
| this._ipld = new Ipld(this._options.ipld) |
There was a problem hiding this comment.
Does this look better ?
this._ipld = new Ipld(Object.assign({}, { formats: [ipldDagPb] }, this._options.ipld, { blockService: this._blockService } ))There was a problem hiding this comment.
I've put your code in a file:
'use strict'
const ipldDagPb = 'ipldDagPb'
const _options = {ipld: {blockService: 'passed in block service'}}
const _blockService = 'blockService'
const result = Object.assign(
{},
{ formats: [ipldDagPb] },
_options.ipld,
{ blockService: _blockService }
)
console.log(result)The out put is { formats: [ 'ipldDagPb' ], blockService: 'blockService' }, but I would expect it to be
{ formats: [ 'ipldDagPb' ], blockService: 'passed in block service' }
There was a problem hiding this comment.
this is correct for js-ipfs! we need to force the already instantiated blockservice or we will need to deal with the repo instantiation.
ipld blockservice option is an instance and not a reference, and blockservice needs a repo, but ipfs already creates a repo in the instantiation/init/start lifecycle. This will get complex very fast lol :)
i think we should force blockservice and maybe in a future PR handle all the blockservice/repo instances sync with ipld config
|
This PR is superseded by: #1668. |
js-ipld 0.19 has breaking changes that affect this project. Therefore
also update the corresponding code.
This is a WIP and will be force-updated once js-ipld 0.19 was released.