The Interplanetary File System (IPFS), implemented in Rust
Table of Contents
- Getting Started
Project Status -
You can see details about what's implemented, what's not, and also learn about other ecosystem projects, at Are We IPFS Yet?
For more information about IPFS see: https://docs.ipfs.io/introduction/overview/
Rust IPFS depends on
First, install the dependencies.
# apt-get install protobuf-compiler libssl-dev zlib1g-dev
# yum install protobuf-compiler libssl-dev zlib1g-dev
rust-ipfs binaries can be built from source. Our goal is to always be compatible with the stable release of Rust.
$ git clone https://github.com/rs-ipfs/rust-ipfs && cd rust-ipfs $ cargo build --workspace
You will then find the binaries inside of the project root's
Note: binaries available via
cargo install is coming soon.
Special thanks to the Web3 Foundation and Protocol Labs for their devgrant support.
- Project Setup
- Testing Setup
- Conformance testing
- HTTP API Scaffolding
- UnixFS Support
Work in Progress
- interop testing
Work still required
/files(regular and mfs)
- a few other miscellaneous endpoints not enumerated here
Alternatives and other cool, related projects
It’s been noted that the Rust-IPFS name and popularity may serve its organization from a "first-mover" perspective. However, alternatives with different philosophies do exist, and we believe that supporting a diverse IPFS community is important and will ultimately help produce the best solution possible.
rust-ipfs-api- A Rust client for an existing IPFS HTTP API. Supports both hyper and actix.
ipfs-embed- An implementation based on
rust-ipld- Basic rust ipld library supporting
- PolkaX's own
rust-libp2p, which does a lot the of heavy lifting here
If you know of another implementation or another cool project adjacent to these efforts, let us know!
See the contributing docs for more info.
You can also back the project financially by reaching out or by becoming a backer on OpenCollective
This project exists thanks to all the people who contribute. [Contribute].
Become a financial contributor and help us sustain our community. [Contribute]
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
The Rust logo and wordmark are trademarks owned and protected by the Mozilla Foundation. The Rust and Cargo logos (bitmap and vector) are owned by Mozilla and distributed under the terms of the Creative Commons Attribution license (CC-BY).