探客时代
IPFS
IPFS implementation in JavaScript
README
The JavaScript implementation of the IPFS protocol
Getting started
Read the docs
Ensure CORS is correctly configured for use with the HTTP client
Look into the examples to learn how to spawn an IPFS node in Node.js and in the Browser
Consult the Core API docs to see what you can do with an IPFS node
Head over to https://proto.school to take the IPFS course that covers core IPFS concepts and JS APIs
Check out https://docs.ipfs.io for glossary, tips, how-tos and more
Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io
Find out about chat channels, the IPFS newsletter, the IPFS blog, and more in the IPFS community space.
Table of Contents
- Packages
- License
Getting Started
Install as a CLI user
Installing ipfs globally will give you the jsipfs command which you can use to start a daemon running:
- ```console
- $ npm install -g ipfs
- $ jsipfs daemon
- Initializing IPFS daemon...
- js-ipfs version: x.x.x
- System version: x64/darwin
- Node.js version: x.x.x
- Swarm listening on /ip4/127.0
- .... more output
- ```
You can then add a file:
- ```console
- $ jsipfs add ./hello-world.txt
- added QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf hello-world.txt
- ```
Install as an application developer
If you do not need to run a command line daemon, use the ipfs-core package - it has all the features of ipfs but in a lighter package:
- ```console
- $ npm install ipfs-core
- ```
Then start a node in your app:
- ``` js
- import * as IPFS from 'ipfs-core'
- const ipfs = await IPFS.create()
- const { cid } = await ipfs.add('Hello world')
- console.info(cid)
- // QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf
- ```
Documentation
Structure
This project is broken into several modules, their purposes are:
[/packages/interface-ipfs-core](./packages/interface-ipfs-core) Tests to ensure adherence of an implementation to the spec
[/packages/ipfs](./packages/ipfs) An aggregator module that bundles the core implementation, the CLI, HTTP API server and daemon
[/packages/ipfs-cli](./packages/ipfs-cli) A CLI to the core implementation
[/packages/ipfs-core](./packages/ipfs-core) The core implementation
[/packages/ipfs-core-types](./packages/ipfs-core-types) Typescript definitions for the core API
[/packages/ipfs-core-utils](./packages/ipfs-core-utils) Helpers and utilities common to core and the HTTP RPC API client
[/packages/ipfs-daemon](./packages/ipfs-daemon) Run js-IPFS as a background daemon
[/packages/ipfs-grpc-client](./packages/ipfs-grpc-client) A gRPC client for js-IPFS
[/packages/ipfs-grpc-protocol](./packages/ipfs-grpc-protocol) Shared module between the gRPC client and server
[/packages/ipfs-grpc-server](./packages/ipfs-grpc-server) A gRPC-over-websockets server for js-IPFS
[/packages/ipfs-http-client](./packages/ipfs-http-client) A client for the RPC-over-HTTP API presented by both js-ipfs and go-ipfs
[/packages/ipfs-http-server](./packages/ipfs-http-server) JS implementation of the Kubo RPC HTTP API
[/packages/ipfs-http-gateway](./packages/ipfs-http-gateway) JS implementation of the IPFS HTTP Gateway
[/packages/ipfs-http-response](./packages/ipfs-http-response) Creates a HTTP response for a given IPFS Path
[/packages/ipfs-message-port-client](./packages/ipfs-message-port-client) A client for the RPC-over-message-port API presented by js-ipfs running in a shared worker
[/packages/ipfs-message-port-protocol](./packages/ipfs-message-port-protocol) Code shared by the message port client & server
[/packages/ipfs-message-port-server](./packages/ipfs-message-port-server) The server that receives requests from ipfs-message-port-client
Packages
List of the main packages that make up the IPFS ecosystem.
| Package | Version | Deps | CI/Travis | Coverage | Lead |
|---|---|---|---|---|---|
| ---------|---------|---------|---------|---------|--------- | |||||
| **Files** | |||||
| [`ipfs-unixfs`](//github.com/ipfs/js-ipfs-unixfs) | [](//github.com/ipfs/js-ipfs-unixfs/releases) | [](https://david-dm.org/ipfs/js-ipfs-unixfs) | [](https://codecov.io/gh/ipfs/js-ipfs-unixfs) | [Alex |
| **Repo** | |||||
| [`ipfs-repo`](//github.com/ipfs/js-ipfs-repo) | [](//github.com/ipfs/js-ipfs-repo/releases) | [](https://david-dm.org/ipfs/js-ipfs-repo) | [](https://codecov.io/gh/ipfs/js-ipfs-repo) | [Alex |
| [`ipfs-repo-migrations`](//github.com/ipfs/js-ipfs-repo-migrations) | [](//github.com/ipfs/js-ipfs-repo-migrations/releases) | [](https://david-dm.org/ipfs/js-ipfs-repo-migrations) | [](https://codecov.io/gh/ipfs/js-ipfs-repo-migrations) | N/A |
| **Exchange** | |||||
| [`ipfs-bitswap`](//github.com/ipfs/js-ipfs-bitswap) | [](//github.com/ipfs/js-ipfs-bitswap/releases) | [](https://david-dm.org/ipfs/js-ipfs-bitswap) | [](https://codecov.io/gh/ipfs/js-ipfs-bitswap) | [Dirk |
| **IPNS** | |||||
| [`ipns`](//github.com/ipfs/js-ipns) | [](//github.com/ipfs/js-ipns/releases) | [](https://david-dm.org/ipfs/js-ipns) | [](https://codecov.io/gh/ipfs/js-ipns) | [Vasco |
| **Generics/Utils** | |||||
| [`ipfs-utils`](//github.com/ipfs/js-ipfs) | [](//github.com/ipfs/js-ipfs/releases) | [](https://david-dm.org/ipfs/js-ipfs) | [](https://codecov.io/gh/ipfs/js-ipfs) | [Hugo |
| [`ipfs-http-client`](//github.com/ipfs/js-ipfs) | [](//github.com/ipfs/js-ipfs/releases) | [](https://david-dm.org/ipfs/js-ipfs) | [](https://codecov.io/gh/ipfs/js-ipfs) | [Alex |
| [`ipfs-http-response`](//github.com/ipfs/js-ipfs-http-response) | [](//github.com/ipfs/js-ipfs-http-response/releases) | [](https://david-dm.org/ipfs/js-ipfs-http-response) | [](https://codecov.io/gh/ipfs/js-ipfs-http-response) | [Vasco |
| [`ipfsd-ctl`](//github.com/ipfs/js-ipfsd-ctl) | [](//github.com/ipfs/js-ipfsd-ctl/releases) | [](https://david-dm.org/ipfs/js-ipfsd-ctl) | [](https://codecov.io/gh/ipfs/js-ipfsd-ctl) | [Hugo |
| [`is-ipfs`](//github.com/ipfs/is-ipfs) | [](//github.com/ipfs/is-ipfs/releases) | [](https://david-dm.org/ipfs/is-ipfs) | [](https://codecov.io/gh/ipfs/is-ipfs) | [Marcin |
| [`aegir`](//github.com/ipfs/aegir) | [](//github.com/ipfs/aegir/releases) | [](https://david-dm.org/ipfs/aegir) | [](https://codecov.io/gh/ipfs/aegir) | [Hugo |
| **libp2p** | |||||
| [`libp2p`](//github.com/libp2p/js-libp2p) | [](//github.com/libp2p/js-libp2p/releases) | [](https://david-dm.org/libp2p/js-libp2p) | [](https://codecov.io/gh/libp2p/js-libp2p) | [Jacob |
| [`peer-id`](//github.com/libp2p/js-peer-id) | [](//github.com/libp2p/js-peer-id/releases) | [](https://david-dm.org/libp2p/js-peer-id) | [](https://codecov.io/gh/libp2p/js-peer-id) | [Vasco |
| [`libp2p-crypto`](//github.com/libp2p/js-libp2p-crypto) | [](//github.com/libp2p/js-libp2p-crypto/releases) | [](https://david-dm.org/libp2p/js-libp2p-crypto) | [](https://codecov.io/gh/libp2p/js-libp2p-crypto) | [Jacob |
| [`libp2p-floodsub`](//github.com/libp2p/js-libp2p-floodsub) | [](//github.com/libp2p/js-libp2p-floodsub/releases) | [](https://david-dm.org/libp2p/js-libp2p-floodsub) | [](https://codecov.io/gh/libp2p/js-libp2p-floodsub) | [Vasco |
| [`libp2p-gossipsub`](//github.com/ChainSafe/gossipsub-js) | [](//github.com/ChainSafe/gossipsub-js/releases) | [](https://david-dm.org/ChainSafe/gossipsub-js) | [](https://codecov.io/gh/ChainSafe/gossipsub-js) | [Cayman |
| [`libp2p-kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [](//github.com/libp2p/js-libp2p-kad-dht/releases) | [](https://david-dm.org/libp2p/js-libp2p-kad-dht) | [](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) | [Vasco |
| [`libp2p-mdns`](//github.com/libp2p/js-libp2p-mdns) | [](//github.com/libp2p/js-libp2p-mdns/releases) | [](https://david-dm.org/libp2p/js-libp2p-mdns) | [](https://codecov.io/gh/libp2p/js-libp2p-mdns) | [Jacob |
| [`libp2p-bootstrap`](//github.com/libp2p/js-libp2p-bootstrap) | [](//github.com/libp2p/js-libp2p-bootstrap/releases) | [](https://david-dm.org/libp2p/js-libp2p-bootstrap) | [](https://codecov.io/gh/libp2p/js-libp2p-bootstrap) | [Vasco |
| [`@chainsafe/libp2p-noise`](//github.com/ChainSafe/js-libp2p-noise) | [](//github.com/ChainSafe/js-libp2p-noise/releases) | [](https://david-dm.org/ChainSafe/js-libp2p-noise) | [](https://codecov.io/gh/ChainSafe/js-libp2p-noise) | N/A |
| [`libp2p-tcp`](//github.com/libp2p/js-libp2p-tcp) | [](//github.com/libp2p/js-libp2p-tcp/releases) | [](https://david-dm.org/libp2p/js-libp2p-tcp) | [](https://codecov.io/gh/libp2p/js-libp2p-tcp) | [Jacob |
| [`libp2p-webrtc-star`](//github.com/libp2p/js-libp2p-webrtc-star) | [](//github.com/libp2p/js-libp2p-webrtc-star/releases) | [](https://david-dm.org/libp2p/js-libp2p-webrtc-star) | [](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star) | [Vasco |
| [`libp2p-websockets`](//github.com/libp2p/js-libp2p-websockets) | [](//github.com/libp2p/js-libp2p-websockets/releases) | [](https://david-dm.org/libp2p/js-libp2p-websockets) | [](https://codecov.io/gh/libp2p/js-libp2p-websockets) | [Jacob |
| [`libp2p-mplex`](//github.com/libp2p/js-libp2p-mplex) | [](//github.com/libp2p/js-libp2p-mplex/releases) | [](https://david-dm.org/libp2p/js-libp2p-mplex) | [](https://codecov.io/gh/libp2p/js-libp2p-mplex) | [Vasco |
| [`libp2p-delegated-content-routing`](//github.com/libp2p/js-libp2p-delegated-content-routing) | [](//github.com/libp2p/js-libp2p-delegated-content-routing/releases) | [](https://david-dm.org/libp2p/js-libp2p-delegated-content-routing) | [](https://codecov.io/gh/libp2p/js-libp2p-delegated-content-routing) | [Jacob |
| [`libp2p-delegated-peer-routing`](//github.com/libp2p/js-libp2p-delegated-peer-routing) | [](//github.com/libp2p/js-libp2p-delegated-peer-routing/releases) | [](https://david-dm.org/libp2p/js-libp2p-delegated-peer-routing) | [](https://codecov.io/gh/libp2p/js-libp2p-delegated-peer-routing) | [Jacob |
| **IPLD** | |||||
| [`@ipld/dag-pb`](//github.com/ipld/js-dag-pb) | [](//github.com/ipld/js-dag-pb/releases) | [](https://david-dm.org/ipld/js-dag-pb) | [](https://codecov.io/gh/ipld/js-dag-pb) | N/A |
| [`@ipld/dag-cbor`](//github.com/ipld/js-dag-cbor) | [](//github.com/ipld/js-dag-cbor/releases) | [](https://david-dm.org/ipld/js-dag-cbor) | [](https://codecov.io/gh/ipld/js-dag-cbor) | N/A |
| **Multiformats** | |||||
| [`multiformats`](//github.com/multiformats/js-multiformats) | [](//github.com/multiformats/js-multiformats/releases) | [](https://david-dm.org/multiformats/js-multiformats) | [](https://codecov.io/gh/multiformats/js-multiformats) | N/A |
| [`mafmt`](//github.com/multiformats/js-mafmt) | [](//github.com/multiformats/js-mafmt/releases) | [](https://david-dm.org/multiformats/js-mafmt) | [](https://codecov.io/gh/multiformats/js-mafmt) | [Vasco |
| [`multiaddr`](//github.com/multiformats/js-multiaddr) | [](//github.com/multiformats/js-multiaddr/releases) | [](https://david-dm.org/multiformats/js-multiaddr) | [](https://codecov.io/gh/multiformats/js-multiaddr) | [Jacob |
This table is generated using the module [package-table](https://www.npmjs.com/package/package-table) with package-table --data=package-list.json.
Want to hack on IPFS?
The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:
Read the Code of Conduct and JavaScript Contributing Guidelines.
- Check out existing issues The issue list has many that are marked as 'help wanted' or 'difficulty:easy' which make great starting points for development, many of which can be tackled with no prior IPFS knowledge
- Look at the IPFS Roadmap This are the high priority items being worked on right now
- Perform code reviews More eyes will help
a. speed the project along
b. ensure quality, and
c. reduce possible future bugs.
- Add tests. There can never be enough tests.
License
