Getting jsipfs out the door #35

daviddias · 2015-11-05T16:47:04Z

WIP

Context and Plan - https://github.com/ipfs/js-ipfs/tree/jsipfs#getting-jsipfs-ready

Architecture

┌───┐    ┌───────────────┐    ┌──────────────┐
│CLI│───▶│   HTTP API    ├───▶│IPFS Node Impl│
└───┘    └───────────────┘    └──────────────┘
                 △                    △
                 └──────────┬─────────┘
                            │
                         ┌─────┐
                         │Tests│
                         └─────┘

CLI
- ronin
HTTP API
- Hapijs
Tests
- Mocha + Karma

Action Items

Contributions are welcome!

masylum · 2015-11-17T08:05:04Z

While I understand the migration path, this looks like this should belong to a js-ipfs-cli repository rather than the js-ipfs one. I would split both concepts since one will be the node-only CLI (even in src/index.js you have process stuff hardcoded) and the other will be the library which has to be browser-compatible.

Example: I should be able to soon implement ipfs.repo() that works both on the browser and node and then implement ipfs repo for the cli.

dignifiedquire · 2015-11-17T09:47:50Z

Fully agree with @masylum js-ipfs should be a simple library (browser + node), and js-ipfs-cli would be the cli tool (only node).

daviddias · 2015-11-17T10:23:48Z

When I started doing this effort, setting up my mind to have 'feature parity' with go-ipfs was the easiest way to grasp and start the endeavour (at least for me, at that time), then talking with Juan, I realised an even simpler, powerful way would be to expose the HTTP API and use go-ipfs sharness tests against the Node.js js-ipfs HTTP API, this would guarantee that both implementations are indeed really close.

This shifts the focus away from implementing the CLI to the HTTP API, so things are separated, as you suggested :)

jbenet · 2015-11-19T05:43:43Z

Btw I'm not opposed to writing the cli in js, but I think right now it will
be a waste of time given the go one can do it all and target any api (with
--api $addr or a .ipfs/api file)

(Eventually may want one too but I imagine we can keep things simpler for
now by using the go one. We could pull it out of go-ipfs if it would help
reading it and contributions)

Btw am contemplating pulling out go-ipfs/core into its own repo.
(Go-ipfs-core). With go-ipfs being the "distribution". Imagine js-ipfs-core
could be a thing too
On Tue, Nov 17, 2015 at 02:23 David Dias notifications@github.com wrote:

When I started doing this effort, setting up my mind to have 'feature
parity' with go-ipfs was the easiest way to grasp and start the endeavour
(at least for me, at that time), then talking with Juan, I realised an even
simpler, powerful way would be to expose the HTTP API and use go-ipfs
sharness tests against the Node.js js-ipfs HTTP API, this would guarantee
that both implementations are indeed really close.

This shifts the focus away from implementing the CLI to the HTTP API, so
things are separated, as you suggested :)

—
Reply to this email directly or view it on GitHub
#35 (comment).

dignifiedquire · 2015-11-25T10:58:34Z

Some explanations for people who are not @diasdavid ;)

impl - Implementation
cli - Available as a cli command through ronin
test- node based tests (passing ✅)
browser - browser based tests (passing ✅)

daviddias · 2015-11-27T17:50:54Z

@lgierth can I get a writable IPFS node (one or more) in the network, to be the node this will delegate to?

jbenet · 2015-12-01T14:07:41Z

@diasdavid writable nodes in the network that we run as part of the gateway will only be writable for temporary content for now. other things (like ipfs name publish, wont work yet)

daviddias · 2015-12-01T18:58:19Z

@diasdavid writable nodes in the network that we run as part of the gateway will only be writable for temporary content for now. other things (like ipfs name publish, wont work yet)

It would be very cool if we could spawn some on demand nodes inside Docker Containers, through an API request, with like 2gb of Storage, so that everyone could do IPNS as well :):)

jbenet · 2015-12-02T12:51:15Z

@diasdavid yeah would be nice!!

on ipns-- we should be able to do IPNS even without ipfs nodes. i'll make a webapp that does it.

we'll need to be able to have other nodes re-share your records, this is a fundamentally tricky bit before data file storage is widely available.

daviddias · 2015-12-10T22:48:19Z

I'm going to merge this one, now that we have a Roadmap, we can create smaller branches and enable more collaboration :)

Getting jsipfs out the door

daviddias added 6 commits November 5, 2015 15:03

jsipfs roadmap

bbe6d1c

add commands for ronin

ae86582

base for commands

fef5f17

help menu formmater

7880218

tests base with disposable daemon

43712e7

ipfs init

dac840e

daviddias mentioned this pull request Nov 6, 2015

Sprint Nov 2 ipfs/team-mgmt#46

Closed

11 tasks

add

932b5ce

This was referenced Nov 9, 2015

Sprint Nov 9 ipfs/team-mgmt#51

Closed

Sprint Nov 16 ipfs/team-mgmt#55

Closed

daviddias mentioned this pull request Nov 23, 2015

Sprint Nov 23 ipfs/team-mgmt#56

Closed

42 tasks

daviddias added the help wanted label Nov 27, 2015

daviddias added 4 commits November 27, 2015 22:05

remove current tests to start again

da015c8

refresh

f9ffa7c

badgers

0685f53

update package.json

29abfb0

daviddias mentioned this pull request Nov 30, 2015

Sprint Nov 30 ipfs/team-mgmt#60

Closed

14 tasks

daviddias added 4 commits December 10, 2015 11:22

add coverage script

583e49b

remove coverage report folder

06f52a2

jsipfs repo version

2374250

Merge branch 'master' of github.com:ipfs/js-ipfs into jsipfs

6e70afb

daviddias added 2 commits December 10, 2015 14:34

update readme

c24f576

add travis config;

35eb22d

daviddias added a commit that referenced this pull request Dec 10, 2015

Merge pull request #35 from ipfs/jsipfs

88cc315

Getting jsipfs out the door

daviddias merged commit 88cc315 into master Dec 10, 2015

daviddias deleted the jsipfs branch December 10, 2015 22:48

dedesite mentioned this pull request Mar 17, 2016

Information about building process and questions jaruba/PowderNPAPI#1

Open

awaisab172 mentioned this pull request Jan 27, 2021

[Snyk] Fix for 1 vulnerabilities awaisab172/js-ipfs#18

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Getting jsipfs out the door #35

Getting jsipfs out the door #35

daviddias commented Nov 5, 2015

masylum commented Nov 17, 2015

dignifiedquire commented Nov 17, 2015

daviddias commented Nov 17, 2015

jbenet commented Nov 19, 2015

dignifiedquire commented Nov 25, 2015

daviddias commented Nov 27, 2015

jbenet commented Dec 1, 2015

daviddias commented Dec 1, 2015

jbenet commented Dec 2, 2015

daviddias commented Dec 10, 2015

Getting jsipfs out the door #35

Getting jsipfs out the door #35

Conversation

daviddias commented Nov 5, 2015

Architecture

Action Items

masylum commented Nov 17, 2015

dignifiedquire commented Nov 17, 2015

daviddias commented Nov 17, 2015

jbenet commented Nov 19, 2015

dignifiedquire commented Nov 25, 2015

daviddias commented Nov 27, 2015

jbenet commented Dec 1, 2015

daviddias commented Dec 1, 2015

jbenet commented Dec 2, 2015

daviddias commented Dec 10, 2015