next generation

[daviddias]

Since this module original inception, a lot has changed in the IPFS JavaScript ecosystem, now we have things like a full implementation of the Protocol in JavaScript, new and more powerful features like the mfs (Mutable File System) API and a lot of the building blocks to make the IPFS experience feel native to JavaScript (having multispecs implementations).

That being said and from all of the new and good things, a lot of technical debt was added, more and more the interfaces feel like something clunky/patched together, making it hard for the community to follow and for developers to decide what to use.

We started the endeavour of creating interface-ipfs-core, an endeavour to standardise what is the core interface an IPFS implementation should offer, this will help developers switch between embebed nodes (js-ipfs) and remote nodes (e.g go-ipfs) without having to change the code in their applications. In addition to this and since this module offered a lot of utilities that came from a direct mapping to the go-ipfs cli, we are keeping them under the .util scope, so that you can continue to use the feature you know and love.

Our goal is with this, get a really solid UX to interact with IPFS, we appreciate everyones feedback and contributions during the process. I'll keep this PR open while we add everything, creating other PR to submit to this one (Block API, mfs API, etc). Below you can see a list of tasks:

ROADMAP

UPDATE ➡️ #305 (comment) ⬅️

• generic API generic API interface-js-ipfs-core#33
  • .id
  • .version
• config API
  • get
  • set
  • replace - requires config.replace is acting weird ipfs/kubo#2927
• block API
  • block.get
  • block.put
  • block.rm
    • Implement in go-ipfs ipfs block rm ipfs/kubo#2914
  • block.stat
• object API
  • object.new
  • object.put
  • object.get
  • object.data
  • object.links
  • object.stat
  • object.patch.addLink
  • object.patch.rmLink
  • object.patch.appendData
  • object.patch.setData
• files API
  • files.add
  • files.add upgrade proposal: Files API - dot return DAGNodes on Add interface-js-ipfs-core#29
  • files.createAddStream
  • files.cat
  • files.get Adds API for ipfs.files.get. interface-js-ipfs-core#28
• mfs API Files, the Mutable File System API interface-js-ipfs-core#38
  • mfs.write
  • mfs.mkdir
  • mfs.stat
  • mfs.flush
  • mfs.read
  • mfs.mv
  • mfs.cp
  • mfs.ls
  • mfs.rm
• swarm API swarm API interface-js-ipfs-core#35
  • swarm.addrs
  • swarm.connect
  • swarm.disconnect
  • swarm.filters
  • swarm.peers
• pinning API pinning API interface-js-ipfs-core#34
  • pin.add
  • ping.rm
  • pin.ls
• name API name API interface-js-ipfs-core#37
  • name.publish
  • name.resolve
• dht API DHT API interface-js-ipfs-core#36
  • dht.findpeer
  • dht.get
  • dht.put
  • dht.query
  • dht.findproovs
• utility functions
  • fsAdd
  • urlAdd
  • streamAdd
• Testing
  • Use bin-wrapper on ipfsd-ctl Upgrade js-ipfsd-ctl to use bin-wrapper ipfs/js-ipfsd-ctl#78
  • Make each batch of tests have its own set up and teardown. (Avoiding to have to run the whole thing at all times, makes development slow)

[daviddias]

Hitting a issue with Karma:

• Needs this to be fixed: Node v4.2.6 - FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - process out of memory karma-runner/karma#1868. Fixed by increasing the memory for Chrome
  • now we need to make a way so that aegir understands it for release:minor

[daviddias]

Now yes :) ready for full review and merge

[victorb]

remove -> remote I'm guessing :)

[daviddias]

Also @dignifiedquire, did you manage to see if we can make aegir release with the increased V8 vm size?

[haadcode]

Missing ) after recursive: true. Might be better to word it as:

Reads a file from path on the filesystem and adds it to IPFS. If path is a directory, use option { recursive: true } to add the directory and all its sub-directories.

[dignifiedquire]

Also @dignifiedquire, did you manage to see if we can make aegir release with the increased V8 vm size?

This works fine for me:

$ node --max_old_space_size=4096 node_modules/.bin/gulp release --type minor

[daviddias]

@dignifiedquire @haadcode can I get a 👍 when you finish your CR. Thank you

[daviddias]

Ok, going to go forward, apply CR and merge.

[dignifiedquire]

👍

[haadcode]

👍

[nginnever]

This LGTM. I just ran all tests against the latest merges of interface-core.

Are we going to follow up on the list items that are not completed yet in new PRs?

[daviddias]

Thank you all :)

@nginnever yes, we are :) See #305 (comment), wanna help?