ipfs/js-ipfsArchived
Js Ipfs
js-ipfs is an HTTP client library that connects to any IPFS daemon, enabling JavaScript applications to interact with the InterPlanetary File System. It provides a promise-based asynchronous API for managing content-addressed storage, where all data is identified by cryptographic hashes (CIDs) for immutable references and deduplication. The library communicates with a remote IPFS node through HTTP requests, supporting cancellation of in-flight operations via standard AbortController signals.
The library offers a comprehensive set of capabilities for working with IPFS, including adding and retrieving content by CID, managing a mutable filesystem with standard read/write/delete operations, and pinning content for permanent storage. It supports peer-to-peer file sharing through a distributed hash table (DHT) for peer discovery and content routing, as well as real-time pub/sub messaging over libp2p for topic-based communication between peers. Users can also publish and resolve IPNS names to create human-readable references to content-addressed data.
Additional functionality includes managing node configuration, monitoring node statistics such as bandwidth usage and repository stats, and querying the DHT to find peers or store key-value pairs. The library supports streaming data transfer for large files, allowing incremental processing without loading entire payloads into memory.
Features
- Content-Addressable Storage - Stores and retrieves files using content hashes as permanent identifiers for verifiable, deduplicated storage.
- HTTP Clients - Ships an HTTP client library that adds, retrieves, and pins content by CID on IPFS nodes.
- HTTP Clients and Servers - Communicates with a remote IPFS daemon through HTTP requests as a client.
- Content-Addressed File Systems - Creates and edits files and directories in a versioned, content-addressed filesystem.
- Distributed Hash Tables - Leverages a Kademlia DHT for peer discovery and decentralized key-value storage.
- Content-Addressable Retrievals - Fetches data from a storage node using content hashes as identifiers.
- Virtual File System Layers - Provides a virtual filesystem layer over content-addressed storage with standard file operations.
- Content Identifiers - Identifies all data by cryptographic content hashes for immutable references and deduplication.
- Peer-to-Peer File Sharing - Provides a client library for sharing files directly between peers using the IPFS distributed network.
- File System Clients - Provides an HTTP client for mutable filesystem operations and IPNS name publishing on IPFS.
- File System Operations - Creates, reads, updates, and deletes files and directories within a mutable file system.
- IPFS Clients - Ships a JavaScript HTTP client library that connects to any IPFS daemon for file and content management.
- Daemon Client Connections - Connects to a remote IPFS daemon via HTTP to enable all API interactions.
- Content-Addressed File Uploads - Uploads data or files to a content-addressed storage node, returning content identifiers for retrieval.
- Decentralized Publishing Tools - Publishes websites and content that remain accessible even if the original server goes offline.
- HTTP Clients - Provides an HTTP client for querying the DHT to find peers and store key-value pairs on IPFS.
- Streaming Transfers - Transfers large files as streams for incremental processing without loading entire payloads into memory.
- Content Pinning - Marks content as pinned to keep it permanently stored on a node, or removes pins for garbage collection.
- HTTP Clients - Ships an HTTP client for subscribing to topics and publishing messages in IPFS's libp2p pub-sub system.
- PubSub Subscribers - Provides an HTTP client for subscribing to topics and publishing messages in IPFS's pub-sub system.
- Mutable Name Resolvers - Publishes content paths under human-readable names and resolves names back to current content paths.
- Pub-Sub Messaging - Implements pub-sub messaging over libp2p for real-time topic-based communication between IPFS peers.
- PubSub Messaging Systems - Uses libp2p's publish-subscribe protocol for real-time topic-based messaging between peers.
- Request Abort Controllers - Implements signal-based abort controllers to cancel active network requests.
- Asynchronous Promise Interfaces - Wraps all operations in JavaScript promises for non-blocking control flow.
- Request Cancellation - Cancels in-flight HTTP requests using standard AbortController signals.
