helia

An implementation of IPFS in JavaScript

Table of contents

• Purpose and goals
• Project status
• Roadmap
• Get involved
• API Docs
• Structure
• Name
• License
• Contribute

Purpose and goals

A lean, modular, and modern implementation of IPFS for the prolific JS and browser environments.

See the Manifesto and the State of IPFS in JS blog post frpom 202210 for more info.

Project status

As of early 2023, this project is pre-alpha and is currently in development. These initial building blocks are in development now; have a look at this repo's PR(s). An initial v1 release is planned for late Q1 2023.

Roadmap

Please find and comment on the Roadmap here.

Get involved

• We are sharing about the progress at periodic Helia Demos. This is a good place to find out the latest and learn of ways to get involved. We'd love to see you there!
• Pick up one of the issues.
• Come chat in Filecoin Slack #ip-js. (Yes, we should bridge this to other chat enviornments. Please comment here if you'd like this.)

API Docs

• https://ipfs.github.io/helia

Structure

• /packages/helia An implementation of IPFS in JavaScript
• /packages/interface The Helia API
• /packages/interop Interop tests for Helia

Name

Helia (HEE-lee-ah) is the Latin spelling of Ἡλιη -- in Greek mythology, one of the Heliades: the daughters of the sun god Helios. When their brother Phaethon died trying to drive the sun chariot across the sky, their tears of mourning fell to earth as amber, which is yellow (sort of), and so is JavaScript. They were then turned into poplar trees and, well, JavaScript is quite popular.

In Oct–Dec 2022, PL EngRes IP Stewards sought community input for the name of this project. After considering 20 suggestions and holding a couple of polls, the name Helia was chosen. Here's why "ipfs" is not in the name.

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.