feat: initial implementation (#17)

- Adds modules for a core library, the interface it implements and an interop suite.

UnixFS support is here: ipfs/helia-unixfs#1, IPNS is here: ipfs/helia-ipns#1 and I've pulled the CLI/RPC parts out to here: ipfs/helia-cli#1

---------

Co-authored-by: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>

.github/workflows/main.yml

@@ -140,16 +140,13 @@ jobs:
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - if: ${{ steps.release.outputs.release_created }}
         name: Run release version
-        run: npm publish
+        run: npm run --if-present release
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - if: ${{ steps.release.outputs.release_created }}
-        name: Publish docs
-        run: npm run --if-present docs
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - if: ${{ !steps.release.outputs.release_created }}
         name: Run release rc
         run: |
-            npm version `node -p -e "require('./package.json').version"`-`git rev-parse --short HEAD` --no-git-tag-version
-            npm publish --tag next
+            npm run --if-present release:rc
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -6,3 +6,4 @@ dist
 node_modules
 package-lock.json
 yarn.lock
+.vscode

README.md

@@ -1,49 +1,76 @@
-# Helia — an implementation of IPFS in JavaScript
+<img src="./assets/helia.png" width="300" height="300" alt="helia logo" style="display: block; margin: auto">
 
-### Project status
+# helia <!-- omit in toc -->
 
-This project is pre-alpha and is currently in development. An initial v1 release is planned for [late Q1 2023](/ROADMAP.md#late-q1-march). Helia is being built in the open; community contributors are welcome!
-
-The core of IPFS is the [Files API](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md), which will likewise be implemented in Helia. These initial building blocks are in development now; have a look at this repo's PR(s). For more info about Helia, please see the [Roadmap](https://github.com/ipfs/helia/issues/5) and the [Manifesto](MANIFESTO.md).
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
 
-We are also sharing about the progress so far, and discussing how you can get involved, at [Helia Demo Day](https://lu.ma/helia) every couple weeks. We'd love to see you there!
+> An implementation of IPFS in JavaScript
 
-## Table of Contents <!-- omit in toc -->
+## Table of contents <!-- omit in toc -->
 
+- [Structure](#structure)
+- [Project status](#project-status)
 - [Name](#name)
 - [Background](#background)
 - [Roadmap](#roadmap)
-- [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribute](#contribute)
+
+## Structure
+
+- [`/packages/helia`](./packages/helia) An implementation of IPFS in JavaScript
+- [`/packages/interface`](./packages/interface) The Helia API
+- [`/packages/interop`](./packages/interop) Interop tests for Helia
+
+## Project status
+
+This project is pre-alpha and is currently in development. An initial v1 release is planned for [late Q1 2023](/ROADMAP.md#late-q1-march). Helia is being built in the open; community contributors are welcome!
+
+The core of IPFS is the [Files API](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md), which will likewise be implemented in Helia. These initial building blocks are in development now; have a look at this repo's PR(s). For more info about Helia, please see the [Roadmap](https://github.com/ipfs/helia/issues/5) and the [Manifesto](MANIFESTO.md).
+
+We are also sharing about the progress so far, and discussing how you can get involved, at [Helia Demo Day](https://lu.ma/helia) every couple weeks. We'd love to see you there!
 
 ## Name
 
-Helia (_HEE-lee-ah_) is the Latin spelling of Ἡλιη -- in Greek mythology, one of the [Heliades](https://www.wikidata.org/wiki/Q12656412): 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](https://en.wiktionary.org/wiki/poplar) trees and, well, JavaScript is quite popular.
+Helia (*HEE-lee-ah*) is the Latin spelling of Ἡλιη -- in Greek mythology, one of the [Heliades](https://www.wikidata.org/wiki/Q12656412): 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](https://en.wiktionary.org/wiki/poplar) trees and, well, JavaScript is quite popular.
 
 In Oct–Dec 2022, IP Stewards [sought](https://github.com/ipfs/pomegranate/issues/3) 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 it's not named IPFS](https://github.com/ipfs/ipfs/issues/470).
 
 ## Background
 
-This project aims to build a lean, modular, modern implementation of IPFS, the Interplanetary File System.
+This project aims to build a lean, modular, and modern implementation of IPFS, the InterPlanetary File System.
 
 For more information, see the [State of IPFS in JS (blog post)](https://blog.ipfs.tech/state-of-ipfs-in-js/).
 
 ## Roadmap
 
 Please find and comment on [the Roadmap here](https://github.com/ipfs/helia/issues/5).
 
-## Contribute
-
 This IPFS implementation in JavaScript is a work in progress. [Here are some ways you can help](https://blog.ipfs.tech/state-of-ipfs-in-js/#%F0%9F%A4%9D-ways-you-can-help)!
-
+
+## API Docs
+
+- <https://ipfs.github.io/helia>
+
 ## License
 
 Licensed under either of
 
- * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
- * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+## Contribute
+
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
+
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
 
-### Contribution
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 
 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.
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "helia-monorepo",
+  "name": "helia",
   "version": "0.0.0",
   "description": "An implementation of IPFS in JavaScript",
   "license": "Apache-2.0 OR MIT",
@@ -20,29 +20,30 @@
   },
   "private": true,
   "scripts": {
-    "reset": "lerna run clean && rimraf ./node_modules ./package-lock.json packages/*/node_modules packages/*/package-lock.json packages/*/dist",
-    "test": "lerna run --concurrency 1 test -- --",
-    "test:node": "lerna run --concurrency 1 test:node -- --",
-    "test:chrome": "lerna run --concurrency 1 test:chrome -- --",
-    "test:chrome-webworker": "lerna --concurrency 1 run test:chrome-webworker -- --",
-    "test:firefox": "lerna run --concurrency 1 test:firefox -- --",
-    "test:firefox-webworker": "lerna run --concurrency 1 test:firefox-webworker -- --",
-    "test:electron-main": "lerna run --concurrency 1 test:electron-main -- --",
-    "test:electron-renderer": "lerna run --concurrency 1 test:electron-renderer -- --",
-    "clean": "lerna run clean",
-    "generate": "lerna run generate",
-    "build": "lerna run build",
-    "lint": "lerna run lint",
+    "reset": "aegir run clean && aegir clean **/node_modules **/package-lock.json",
+    "test": "aegir run test",
+    "test:node": "aegir run test:node",
+    "test:chrome": "aegir run test:chrome",
+    "test:chrome-webworker": "aegir run test:chrome-webworker",
+    "test:firefox": "aegir run test:firefox",
+    "test:firefox-webworker": "aegir run test:firefox-webworker",
+    "test:electron-main": "aegir run test:electron-main",
+    "test:electron-renderer": "aegir run test:electron-renderer",
+    "clean": "aegir run clean",
+    "generate": "aegir run generate",
+    "build": "aegir run build",
+    "lint": "aegir run lint",
     "docs": "NODE_OPTIONS=--max_old_space_size=4096 aegir docs",
     "docs:no-publish": "npm run docs -- --publish false",
-    "dep-check": "lerna run dep-check",
-    "release": "npm run docs:no-publish && lerna run --concurrency 1 release && npm run docs"
+    "dep-check": "aegir run dep-check",
+    "release": "npm run docs:no-publish && npm run release:npm && npm run docs",
+    "release:npm": "aegir exec npm -- publish",
+    "release:rc": "aegir release-rc"
   },
   "dependencies": {
-    "aegir": "^38.1.0",
-    "lerna": "^6.1.0",
-    "rimraf": "^4.1.1"
+    "aegir": "^38.1.0"
   },
+  "type": "module",
   "workspaces": [
     "packages/*"
   ]

packages/helia/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

packages/helia/LICENSE-APACHE

@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

packages/helia/LICENSE-MIT

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

packages/helia/README.md

@@ -0,0 +1,53 @@
+# helia <!-- omit in toc -->
+
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
+
+> An implementation of IPFS in JavaScript
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
+- [API Docs](#api-docs)
+- [License](#license)
+- [Contribute](#contribute)
+
+## Install
+
+```console
+$ npm i helia
+```
+
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Helia` in the global namespace.
+
+```html
+<script src="https://unpkg.com/helia/dist/index.min.js"></script>
+```
+
+## API Docs
+
+- <https://ipfs.github.io/helia/modules/helia.html>
+
+## License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+## Contribute
+
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
+
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) 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](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+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.
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)