Skip to content
This repository has been archived by the owner on Aug 11, 2021. It is now read-only.

update dependencies for js-ipfs 0.33 #166

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 1 addition & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ Want to get started? Check our examples folder. You can check the development st
- [Usage](#usage)
- [API](#api)
- IPLD Resolver
- [Constructor](#ipld-constructor)
- [`.put(node, options, callback)`](#putnode-options-callback)
- [`.get(cid [, path] [, options], callback)`](#getcid--path--options-callback)
- [`.getStream(cid [, path] [, options])`](#getstreamcid--path--options)
Expand Down Expand Up @@ -79,7 +78,7 @@ const initIpld = (ipfsRepoPath, callback) => {
return callback(err)
}
const blockService = new IpfsBlockService(repo)
const ipld = new Ipld({blockService: blockService})
const ipld = new Ipld(blockService)
return callback(null, ipld)
})
})
Expand All @@ -92,29 +91,6 @@ initIpld('/tmp/ifpsrepo', (err, ipld) => {

## API

### IPLD constructor

> Creates and returns an instance of IPLD.

```js
const ipld = new Ipld(options)
```

The `options` is an object with any of these properties:

##### `options.blockService`

| Type | Default |
|------|---------|
| [`ipfs.BlockService`](https://github.com/ipfs/js-ipfs-block-service) instance | Required (no default) |

Example:

```js
const blockService = new IpfsBlockService(repo)
const ipld = new Ipld({blockService: blockService})
```

### `.put(node, options, callback)`

> Store the given node of a recognized IPLD Format.
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,28 +33,28 @@
"homepage": "https://github.com/ipld/js-ipld#readme",
"license": "MIT",
"devDependencies": {
"aegir": "^15.2.0",
"chai": "^4.1.2",
"aegir": "^15.3.1",
"chai": "^4.2.0",
"dirty-chai": "^2.0.1",
"eth-hash-to-cid": "~0.1.1",
"ethereumjs-block": "^2.0.1",
"ethereumjs-block": "^2.1.0",
"multihashes": "~0.4.14",
"ncp": "^2.0.0",
"rimraf": "^2.6.2",
"rlp": "^2.1.0"
},
"dependencies": {
"async": "^2.6.1",
"cids": "~0.5.4",
"interface-datastore": "~0.5.0",
"cids": "~0.5.5",
"interface-datastore": "~0.6.0",
"ipfs-block": "~0.7.1",
"ipfs-block-service": "~0.14.0",
"ipfs-repo": "~0.24.0",
"ipld-bitcoin": "~0.1.7",
"ipld-bitcoin": "~0.1.8",
"ipld-dag-cbor": "~0.13.0",
"ipld-dag-pb": "~0.14.10",
"ipld-ethereum": "^2.0.1",
"ipld-git": "~0.2.1",
"ipld-git": "~0.2.2",
"ipld-raw": "^2.0.1",
"ipld-zcash": "~0.1.6",
"pull-defer": "~0.2.3",
Expand Down
8 changes: 4 additions & 4 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ const MemoryStore = require('interface-datastore').MemoryDatastore
function noop () {}

class IPLDResolver {
constructor (options) {
if (!options.blockService) {
constructor (blockService) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why move this back?

if (!blockService) {
throw new Error('Missing blockservice')
}

this.bs = options.blockService
this.bs = blockService

// Support by default dag-pb, dag-cbor, git, and eth-*
this.resolvers = {
Expand Down Expand Up @@ -439,7 +439,7 @@ IPLDResolver.inMemory = function (callback) {
if (err) {
return callback(err)
}
callback(null, new IPLDResolver({blockService}))
callback(null, new IPLDResolver(blockService))
})
}

Expand Down
14 changes: 7 additions & 7 deletions test/basics.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ module.exports = (repo) => {
describe('basics', () => {
it('creates an instance', () => {
const bs = new BlockService(repo)
const r = new IPLDResolver({blockService: bs})
const r = new IPLDResolver(bs)
expect(r.bs).to.exist()
})

Expand All @@ -34,7 +34,7 @@ module.exports = (repo) => {
describe('validation', () => {
it('get - errors on unknown resolver', (done) => {
const bs = new BlockService(repo)
const r = new IPLDResolver({blockService: bs})
const r = new IPLDResolver(bs)
// choosing a format that is not supported
const cid = new CID(1, 'base1', multihash.encode(Buffer.from('abcd', 'hex'), 'sha1'))
r.get(cid, '/', {}, (err, result) => {
Expand All @@ -46,7 +46,7 @@ module.exports = (repo) => {

it('_get - errors on unknown resolver', (done) => {
const bs = new BlockService(repo)
const r = new IPLDResolver({blockService: bs})
const r = new IPLDResolver(bs)
// choosing a format that is not supported
const cid = new CID(1, 'base1', multihash.encode(Buffer.from('abcd', 'hex'), 'sha1'))
r.get(cid, (err, result) => {
Expand All @@ -58,7 +58,7 @@ module.exports = (repo) => {

it('put - errors on unknown resolver', (done) => {
const bs = new BlockService(repo)
const r = new IPLDResolver({blockService: bs})
const r = new IPLDResolver(bs)
// choosing a format that is not supported
r.put(null, { format: 'base1' }, (err, result) => {
expect(err).to.exist()
Expand All @@ -69,7 +69,7 @@ module.exports = (repo) => {

it('put - errors if no options', (done) => {
const bs = new BlockService(repo)
const r = new IPLDResolver({blockService: bs})
const r = new IPLDResolver(bs)
r.put(null, (err, result) => {
expect(err).to.exist()
expect(err.message).to.eql('IPLDResolver.put requires options')
Expand All @@ -79,7 +79,7 @@ module.exports = (repo) => {

it('_put - errors on unknown resolver', (done) => {
const bs = new BlockService(repo)
const r = new IPLDResolver({blockService: bs})
const r = new IPLDResolver(bs)
// choosing a format that is not supported
const cid = new CID(1, 'base1', multihash.encode(Buffer.from('abcd', 'hex'), 'sha1'))
r._put(cid, null, (err, result) => {
Expand All @@ -91,7 +91,7 @@ module.exports = (repo) => {

it('treeStream - errors on unknown resolver', (done) => {
const bs = new BlockService(repo)
const r = new IPLDResolver({blockService: bs})
const r = new IPLDResolver(bs)
// choosing a format that is not supported
const cid = new CID(1, 'base1', multihash.encode(Buffer.from('abcd', 'hex'), 'sha1'))
pull(
Expand Down
2 changes: 1 addition & 1 deletion test/ipld-bitcoin.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ module.exports = (repo) => {

before((done) => {
const bs = new BlockService(repo)
resolver = new IPLDResolver({blockService: bs})
resolver = new IPLDResolver(bs)

series([
(cb) => {
Expand Down
2 changes: 1 addition & 1 deletion test/ipld-dag-cbor.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module.exports = (repo) => {
before((done) => {
const bs = new BlockService(repo)

resolver = new IPLDResolver({blockService: bs})
resolver = new IPLDResolver(bs)

series([
(cb) => {
Expand Down
2 changes: 1 addition & 1 deletion test/ipld-dag-pb.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module.exports = (repo) => {
before((done) => {
const bs = new BlockService(repo)

resolver = new IPLDResolver({blockService: bs})
resolver = new IPLDResolver(bs)

series([
(cb) => {
Expand Down
2 changes: 1 addition & 1 deletion test/ipld-eth-block.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module.exports = (repo) => {

before((done) => {
const bs = new BlockService(repo)
resolver = new IPLDResolver({blockService: bs})
resolver = new IPLDResolver(bs)

series([
(cb) => {
Expand Down
2 changes: 1 addition & 1 deletion test/ipld-eth.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ module.exports = (repo) => {
before(function (done) {
this.timeout(10 * 1000)
const bs = new BlockService(repo)
resolver = new IPLDResolver({blockService: bs})
resolver = new IPLDResolver(bs)

async.waterfall([
readFilesFixture,
Expand Down
2 changes: 1 addition & 1 deletion test/ipld-git.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ module.exports = (repo) => {
before((done) => {
const bs = new BlockService(repo)

resolver = new IPLDResolver({blockService: bs})
resolver = new IPLDResolver(bs)

series([
(cb) => {
Expand Down
2 changes: 1 addition & 1 deletion test/ipld-zcash.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ module.exports = (repo) => {

before((done) => {
const bs = new BlockService(repo)
resolver = new IPLDResolver({blockService: bs})
resolver = new IPLDResolver(bs)

series([
(cb) => {
Expand Down