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

next generation - #305

Merged
daviddias merged 17 commits into
masterfrom
ipfs-api/ng
Aug 18, 2016
Merged

daviddias merged 17 commits into
masterfrom
ipfs-api/ng

Conversation

@daviddias

@daviddias daviddias commented Jun 30, 2016 •

Copy link
Copy Markdown
Contributor

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) ⬅️

@daviddias

daviddias commented Aug 16, 2016 •

Copy link
Copy Markdown
Contributor Author

Hitting a issue with Karma:

@daviddias daviddias mentioned this pull request Aug 16, 2016
1 task done
@daviddias

Copy link
Copy Markdown
Contributor Author

Now yes :) ready for full review and merge

Comment thread README.md Outdated
[![Circle CI](https://circleci.com/gh/ipfs/js-ipfs-api.svg?style=svg)](https://circleci.com/gh/ipfs/js-ipfs-api)

> A client library for the IPFS HTTP API, implemented in JavaScript.
> A client library for the IPFS HTTP API, implemented in JavaScript. This client library implements the [interface-ipfs-core](https://github.com/ipfs/interface-ipfs-core) enabling applications to change between a embebed js-ipfs node and any remove IPFS node without having to change the code. In addition, this client library implements a set of utility functions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

remove -> remote I'm guessing :)

@daviddias

Copy link
Copy Markdown
Contributor Author

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

Comment thread README.md
> `ipfs.util.fsAdd(path, option, callback)`

Reads path from disk (if directory add an options `{ recursive: true }` and adds it to IPFS.

@haadcode haadcode Aug 17, 2016 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor Author

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

@daviddias

Copy link
Copy Markdown
Contributor Author

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

@dignifiedquire

Copy link
Copy Markdown
Contributor

👍

1 similar comment
@haadcode

Copy link
Copy Markdown
Contributor

👍

@nginnever

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor Author

Thank you all :)

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

@daviddias
daviddias merged commit 8db5536 into master Aug 18, 2016
@daviddias
daviddias deleted the ipfs-api/ng branch August 18, 2016 17:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants