You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 12, 2024. It is now read-only.
> IPFS JavaScript implementation entry point and roadmap
10
+
> IPFS JavaScript implementation.
7
11
8
12
# Description
9
13
10
-
This repo will contain the entry point for the JavaScript implementation of IPFS spec, similar to [go-ipfs](https://github.com/ipfs/go-ipfs).
14
+
This repo contains the JavaScript implementation of the IPFS protocol, with feature parity to the [Go implementation](https://github.com/ipfs/go-ipfs).
11
15
12
-
We are building js-ipfs because it will inform how go-ipfs works, separate concerns, and allow a complete in-browser-tab implementation with no install friction. Most of the work for IPFS does happen elsewhere, but this is an equally important part of our roadmap to lead to a permanent, IPFSed web.
16
+
# Project status
17
+
18
+
Consult the [Roadmap](/ROADMAP.md) for a complete state description of the project. A lot of components can be used currently, but it is a WIP, so beware of the Dragons.
13
19
14
20
# Contribute
15
21
@@ -23,8 +29,6 @@ IPFS implementation in JavaScript is a work in progress. As such, there's a few
23
29
24
30
# Usage
25
31
26
-
> **Disclamer: Currently, js-ipfs is not a full IPFS node, it delegates all of its operations to a IPFS node available in the network, see "Getting jsipfs ready" below for more details.
27
-
28
32
### Installation
29
33
30
34
```bash
@@ -47,6 +51,14 @@ $ npm install ipfs --global
47
51
48
52
The cli is availble through `jsipfs` in your terminal
49
53
54
+
# Examples
55
+
56
+
> **WIP**
57
+
58
+
# API
59
+
60
+
> **WIP**
61
+
50
62
# Project structure
51
63
52
64
```
@@ -141,110 +153,3 @@ Files is the API that lets us work with IPFS objects (DAG Nodes) as if they were
141
153
#### Importer
142
154
143
155
Importer are a set of layouts (e.g. UnixFS) and chunkers (e.g: fixed-size, rabin, etc) that convert data to a MerkleDAG representation inside IPFS.
144
-
145
-
# Usage
146
-
147
-
> This is a WIP, beware of Dragons!
148
-
149
-
# Project Status
150
-
151
-
### Per component view
152
-
153
-
| Name | Spec | Disc |
154
-
| :----| :----| :----|
155
-
| data importing | https://github.com/ipfs/specs/pull/57 | https://github.com/ipfs/js-ipfs/issues/41
> Summary: This milestone's focus is to ship a version of js-ipfs that can be embed in browser applications, creating an IPFS node inside a browser web application.
7
+
8
+
### Tasks:
9
+
10
+
-[ ] files API
11
+
-[x] js-ipfs-unixfs
12
+
-[x] fixed size chunker
13
+
-[x] unixfs layout
14
+
-[x] jsipfs files add
15
+
-[ ] jsipfs files get
16
+
-[ ] jsipfs swarm
17
+
-[x] listen on WebSockets + TCP
18
+
-[x] spdy support
19
+
-[x] identify protocol
20
+
-[x] multistream
21
+
-[ ] connect
22
+
-[ ] interop with go-ipfs (tests)
23
+
-[x] block API
24
+
-[x] object API
25
+
-[x] js-ipfs-merkle-dag
26
+
-[x] repo API
27
+
-[ ] bitswap
28
+
- js-libp2p
29
+
-[x] js-libp2p-swarm
30
+
-[x] js-libp2p-tcp
31
+
-[x] js-libp2p-websockets
32
+
-[x] js-libp2p-spdy
33
+
-[x] js-multiaddr
34
+
-[x] js-multistream
35
+
-[x] js-peer-id
36
+
-[x] js-peer-info
37
+
-[x] js-webcrypto
38
+
39
+
### Notes:
40
+
41
+
- This releasel won't:
42
+
- support WebRTC, the communication between browser and machine nodes will happen through WebSockets+SPDY.
43
+
- won't have DHT (Kademlia Routing and Record Store) support.
44
+
45
+
# Milestone 2 - TBD
46
+
47
+
> Summary: TO BE DISCUSSED
48
+
49
+
# Project Status
50
+
51
+
### Per component view
52
+
53
+
| Name | Spec | Disc |
54
+
| :----| :----| :----|
55
+
| data importing | https://github.com/ipfs/specs/pull/57 | https://github.com/ipfs/js-ipfs/issues/41
0 commit comments