helia 0.0.0-270bb98

package/dist/src/utils/dag-walkers.js

@@ -0,0 +1,145 @@
+/* eslint max-depth: ["error", 7] */
+import * as dagPb from '@ipld/dag-pb';
+import * as cborg from 'cborg';
+import { Type, Token } from 'cborg';
+import * as cborgJson from 'cborg/json';
+import * as raw from 'multiformats/codecs/raw';
+import { CID } from 'multiformats';
+import { base64 } from 'multiformats/bases/base64';
+/**
+ * Dag walker for dag-pb CIDs
+ */
+export const dagPbWalker = {
+    codec: dagPb.code,
+    async *walk(block) {
+        const node = dagPb.decode(block);
+        yield* node.Links.map(l => l.Hash);
+    }
+};
+/**
+ * Dag walker for raw CIDs
+ */
+export const rawWalker = {
+    codec: raw.code,
+    async *walk() {
+        // no embedded CIDs in a raw block
+    }
+};
+// https://github.com/ipfs/go-ipfs/issues/3570#issuecomment-273931692
+const CID_TAG = 42;
+/**
+ * Dag walker for dag-cbor CIDs. Does not actually use dag-cbor since
+ * all we are interested in is extracting the the CIDs from the block
+ * so we can just use cborg for that.
+ */
+export const cborWalker = {
+    codec: 0x71,
+    async *walk(block) {
+        const cids = [];
+        const tags = [];
+        tags[CID_TAG] = (bytes) => {
+            if (bytes[0] !== 0) {
+                throw new Error('Invalid CID for CBOR tag 42; expected leading 0x00');
+            }
+            const cid = CID.decode(bytes.subarray(1)); // ignore leading 0x00
+            cids.push(cid);
+            return cid;
+        };
+        cborg.decode(block, {
+            tags
+        });
+        yield* cids;
+    }
+};
+/**
+ * Borrowed from @ipld/dag-json
+ */
+class DagJsonTokenizer extends cborgJson.Tokenizer {
+    constructor(data, options) {
+        super(data, options);
+        this.tokenBuffer = [];
+    }
+    done() {
+        return this.tokenBuffer.length === 0 && super.done();
+    }
+    _next() {
+        if (this.tokenBuffer.length > 0) {
+            // @ts-expect-error https://github.com/Microsoft/TypeScript/issues/30406
+            return this.tokenBuffer.pop();
+        }
+        return super.next();
+    }
+    /**
+     * Implements rules outlined in https://github.com/ipld/specs/pull/356
+     */
+    next() {
+        const token = this._next();
+        if (token.type === Type.map) {
+            const keyToken = this._next();
+            if (keyToken.type === Type.string && keyToken.value === '/') {
+                const valueToken = this._next();
+                if (valueToken.type === Type.string) { // *must* be a CID
+                    const breakToken = this._next(); // swallow the end-of-map token
+                    if (breakToken.type !== Type.break) {
+                        throw new Error('Invalid encoded CID form');
+                    }
+                    this.tokenBuffer.push(valueToken); // CID.parse will pick this up after our tag token
+                    return new Token(Type.tag, 42, 0);
+                }
+                if (valueToken.type === Type.map) {
+                    const innerKeyToken = this._next();
+                    if (innerKeyToken.type === Type.string && innerKeyToken.value === 'bytes') {
+                        const innerValueToken = this._next();
+                        if (innerValueToken.type === Type.string) { // *must* be Bytes
+                            for (let i = 0; i < 2; i++) {
+                                const breakToken = this._next(); // swallow two end-of-map tokens
+                                if (breakToken.type !== Type.break) {
+                                    throw new Error('Invalid encoded Bytes form');
+                                }
+                            }
+                            const bytes = base64.decode(`m${innerValueToken.value}`);
+                            return new Token(Type.bytes, bytes, innerValueToken.value.length);
+                        }
+                        this.tokenBuffer.push(innerValueToken); // bail
+                    }
+                    this.tokenBuffer.push(innerKeyToken); // bail
+                }
+                this.tokenBuffer.push(valueToken); // bail
+            }
+            this.tokenBuffer.push(keyToken); // bail
+        }
+        return token;
+    }
+}
+/**
+ * Dag walker for dag-json CIDs. Does not actually use dag-json since
+ * all we are interested in is extracting the the CIDs from the block
+ * so we can just use cborg/json for that.
+ */
+export const jsonWalker = {
+    codec: 0x0129,
+    async *walk(block) {
+        const cids = [];
+        const tags = [];
+        tags[CID_TAG] = (string) => {
+            const cid = CID.parse(string);
+            cids.push(cid);
+            return cid;
+        };
+        cborgJson.decode(block, {
+            tags,
+            tokenizer: new DagJsonTokenizer(block, {
+                tags,
+                allowIndefinite: true,
+                allowUndefined: true,
+                allowNaN: true,
+                allowInfinity: true,
+                allowBigInt: true,
+                strict: false,
+                rejectDuplicateMapKeys: false
+            })
+        });
+        yield* cids;
+    }
+};
+//# sourceMappingURL=dag-walkers.js.map

package/dist/src/utils/dag-walkers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dag-walkers.js","sourceRoot":"","sources":["../../../src/utils/dag-walkers.ts"],"names":[],"mappings":"AAAA,oCAAoC;AAEpC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AACnC,OAAO,KAAK,SAAS,MAAM,YAAY,CAAA;AAEvC,OAAO,KAAK,GAAG,MAAM,yBAAyB,CAAA;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAElD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAc;IACpC,KAAK,EAAE,KAAK,CAAC,IAAI;IACjB,KAAK,CAAC,CAAE,IAAI,CAAE,KAAK;QACjB,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAEhC,KAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;CACF,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAc;IAClC,KAAK,EAAE,GAAG,CAAC,IAAI;IACf,KAAK,CAAC,CAAE,IAAI;QACV,kCAAkC;IACpC,CAAC;CACF,CAAA;AAED,qEAAqE;AACrE,MAAM,OAAO,GAAG,EAAE,CAAA;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAc;IACnC,KAAK,EAAE,IAAI;IACX,KAAK,CAAC,CAAE,IAAI,CAAE,KAAK;QACjB,MAAM,IAAI,GAAU,EAAE,CAAA;QACtB,MAAM,IAAI,GAAuB,EAAE,CAAA;QACnC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;YACxB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;gBAClB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;aACtE;YAED,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,sBAAsB;YAEhE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAEd,OAAO,GAAG,CAAA;QACZ,CAAC,CAAA;QAED,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE;YAClB,IAAI;SACL,CAAC,CAAA;QAEF,KAAM,CAAC,CAAC,IAAI,CAAA;IACd,CAAC;CACF,CAAA;AAED;;GAEG;AACH,MAAM,gBAAiB,SAAQ,SAAS,CAAC,SAAS;IAGhD,YAAa,IAAgB,EAAE,OAA6B;QAC1D,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAEpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAA;IACvB,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAA;IACtD,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,wEAAwE;YACxE,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAA;SAC9B;QACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;QAE1B,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,GAAG,EAAE;YAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;YAC7B,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,IAAI,QAAQ,CAAC,KAAK,KAAK,GAAG,EAAE;gBAC3D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;gBAC/B,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,EAAE,EAAE,kBAAkB;oBACvD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA,CAAC,+BAA+B;oBAC/D,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,EAAE;wBAClC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;qBAC5C;oBACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA,CAAC,kDAAkD;oBACpF,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;iBAClC;gBACD,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,GAAG,EAAE;oBAChC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;oBAClC,IAAI,aAAa,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,IAAI,aAAa,CAAC,KAAK,KAAK,OAAO,EAAE;wBACzE,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;wBACpC,IAAI,eAAe,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,EAAE,EAAE,kBAAkB;4BAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;gCAC1B,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA,CAAC,gCAAgC;gCAChE,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,EAAE;oCAClC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;iCAC9C;6BACF;4BACD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,KAAK,EAAE,CAAC,CAAA;4BACxD,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;yBAClE;wBACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA,CAAC,OAAO;qBAC/C;oBACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA,CAAC,OAAO;iBAC7C;gBACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA,CAAC,OAAO;aAC1C;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA,CAAC,OAAO;SACxC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAc;IACnC,KAAK,EAAE,MAAM;IACb,KAAK,CAAC,CAAE,IAAI,CAAE,KAAK;QACjB,MAAM,IAAI,GAAU,EAAE,CAAA;QACtB,MAAM,IAAI,GAAuB,EAAE,CAAA;QACnC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE;YACzB,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YAE7B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAEd,OAAO,GAAG,CAAA;QACZ,CAAC,CAAA;QAED,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE;YACtB,IAAI;YACJ,SAAS,EAAE,IAAI,gBAAgB,CAAC,KAAK,EAAE;gBACrC,IAAI;gBACJ,eAAe,EAAE,IAAI;gBACrB,cAAc,EAAE,IAAI;gBACpB,QAAQ,EAAE,IAAI;gBACd,aAAa,EAAE,IAAI;gBACnB,WAAW,EAAE,IAAI;gBACjB,MAAM,EAAE,KAAK;gBACb,sBAAsB,EAAE,KAAK;aAC9B,CAAC;SACH,CAAC,CAAA;QAEF,KAAM,CAAC,CAAC,IAAI,CAAA;IACd,CAAC;CACF,CAAA"}

package/dist/src/utils/datastore-version.d.ts

@@ -0,0 +1,3 @@
+import { Datastore } from 'interface-datastore';
+export declare function assertDatastoreVersionIsCurrent(datastore: Datastore): Promise<void>;
+//# sourceMappingURL=datastore-version.d.ts.map

package/dist/src/utils/datastore-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"datastore-version.d.ts","sourceRoot":"","sources":["../../../src/utils/datastore-version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAO,MAAM,qBAAqB,CAAA;AAOpD,wBAAsB,+BAA+B,CAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAe1F"}

package/dist/src/utils/datastore-version.js

@@ -0,0 +1,19 @@
+import { Key } from 'interface-datastore';
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
+const DS_VERSION_KEY = new Key('/version');
+const CURRENT_VERSION = 1;
+export async function assertDatastoreVersionIsCurrent(datastore) {
+    if (!(await datastore.has(DS_VERSION_KEY))) {
+        await datastore.put(DS_VERSION_KEY, uint8ArrayFromString(`${CURRENT_VERSION}`));
+        return;
+    }
+    const buf = await datastore.get(DS_VERSION_KEY);
+    const str = uint8ArrayToString(buf);
+    const version = parseInt(str, 10);
+    if (version !== CURRENT_VERSION) {
+        // TODO: write migrations when we break compatibility - for an example, see https://github.com/ipfs/js-ipfs-repo/tree/master/packages/ipfs-repo-migrations
+        throw new Error('Unknown datastore version, a datastore migration may be required');
+    }
+}
+//# sourceMappingURL=datastore-version.js.map

package/dist/src/utils/datastore-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"datastore-version.js","sourceRoot":"","sources":["../../../src/utils/datastore-version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,GAAG,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAEtE,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAA;AAC1C,MAAM,eAAe,GAAG,CAAC,CAAA;AAEzB,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAE,SAAoB;IACzE,IAAI,CAAC,CAAC,MAAM,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,EAAE;QAC1C,MAAM,SAAS,CAAC,GAAG,CAAC,cAAc,EAAE,oBAAoB,CAAC,GAAG,eAAe,EAAE,CAAC,CAAC,CAAA;QAE/E,OAAM;KACP;IAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;IAC/C,MAAM,GAAG,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAA;IACnC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAEjC,IAAI,OAAO,KAAK,eAAe,EAAE;QAC/B,0JAA0J;QAC1J,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAA;KACpF;AACH,CAAC"}

package/package.json

@@ -0,0 +1,176 @@
+{
+  "name": "helia",
+  "version": "0.0.0-270bb98",
+  "description": "An implementation of IPFS in JavaScript",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipfs/helia/tree/master/packages/helia#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs/helia.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ipfs/helia/issues"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "build": "aegir build",
+    "test": "aegir test",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:node": "aegir test -t node --cov",
+    "test:electron-main": "aegir test -t electron-main",
+    "release": "aegir release"
+  },
+  "dependencies": {
+    "@helia/interface": "0.0.0-270bb98",
+    "@ipld/dag-pb": "^4.0.2",
+    "@libp2p/interface-libp2p": "^1.1.0",
+    "@libp2p/interfaces": "^3.3.1",
+    "blockstore-core": "^3.0.0",
+    "cborg": "^1.10.0",
+    "interface-blockstore": "^4.0.1",
+    "interface-datastore": "^7.0.3",
+    "interface-store": "^3.0.4",
+    "ipfs-bitswap": "^16.0.0",
+    "it-all": "^2.0.0",
+    "it-drain": "^2.0.0",
+    "it-filter": "^2.0.0",
+    "it-merge": "^2.0.0",
+    "it-pushable": "^3.1.2",
+    "mortice": "^3.0.1",
+    "multiformats": "^11.0.1",
+    "p-defer": "^4.0.0",
+    "p-queue": "^7.3.4",
+    "progress-events": "^1.0.0",
+    "uint8arrays": "^4.0.3"
+  },
+  "devDependencies": {
+    "@chainsafe/libp2p-noise": "^11.0.0",
+    "@chainsafe/libp2p-yamux": "^3.0.5",
+    "@ipld/dag-cbor": "^9.0.0",
+    "@ipld/dag-json": "^10.0.1",
+    "@libp2p/websockets": "^5.0.3",
+    "aegir": "^38.1.0",
+    "datastore-core": "^8.0.4",
+    "libp2p": "^0.42.2"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
+  }
+}

package/src/helia.ts

@@ -0,0 +1,100 @@
+import type { GCOptions, Helia, InfoResponse } from '@helia/interface'
+import type { Libp2p } from '@libp2p/interface-libp2p'
+import type { Datastore } from 'interface-datastore'
+import { identity } from 'multiformats/hashes/identity'
+import { sha256, sha512 } from 'multiformats/hashes/sha2'
+import type { MultihashHasher } from 'multiformats/hashes/interface'
+import type { HeliaInit } from '.'
+import { Bitswap, createBitswap } from 'ipfs-bitswap'
+import { BlockStorage } from './storage.js'
+import type { Pins } from '@helia/interface/pins'
+import { PinsImpl } from './pins.js'
+import { assertDatastoreVersionIsCurrent } from './utils/datastore-version.js'
+import drain from 'it-drain'
+import { CustomProgressEvent } from 'progress-events'
+
+export class HeliaImpl implements Helia {
+  public libp2p: Libp2p
+  public blockstore: BlockStorage
+  public datastore: Datastore
+  public pins: Pins
+
+  #bitswap: Bitswap
+
+  constructor (init: HeliaInit) {
+    const hashers: MultihashHasher[] = [
+      sha256,
+      sha512,
+      identity,
+      ...(init.hashers ?? [])
+    ]
+
+    this.pins = new PinsImpl(init.datastore, init.blockstore, init.dagWalkers ?? [])
+
+    this.#bitswap = createBitswap(init.libp2p, init.blockstore, {
+      hashLoader: {
+        getHasher: async (codecOrName: string | number) => {
+          const hasher = hashers.find(hasher => {
+            return hasher.code === codecOrName || hasher.name === codecOrName
+          })
+
+          if (hasher != null) {
+            return await Promise.resolve(hasher)
+          }
+
+          throw new Error(`Could not load hasher for code/name "${codecOrName}"`)
+        }
+      }
+    })
+
+    this.libp2p = init.libp2p
+    this.blockstore = new BlockStorage(init.blockstore, this.#bitswap, this.pins)
+    this.datastore = init.datastore
+  }
+
+  async start (): Promise<void> {
+    await assertDatastoreVersionIsCurrent(this.datastore)
+
+    this.#bitswap.start()
+    await this.libp2p.start()
+  }
+
+  async stop (): Promise<void> {
+    this.#bitswap.stop()
+    await this.libp2p.stop()
+  }
+
+  async info (): Promise<InfoResponse> {
+    return {
+      peerId: this.libp2p.peerId,
+      multiaddrs: this.libp2p.getMultiaddrs(),
+      agentVersion: this.libp2p.identifyService.host.agentVersion,
+      protocolVersion: this.libp2p.identifyService.host.protocolVersion,
+      protocols: this.libp2p.getProtocols(),
+      status: this.libp2p.isStarted() ? 'running' : 'stopped'
+    }
+  }
+
+  async gc (options: GCOptions = {}): Promise<void> {
+    const releaseLock = await this.blockstore.lock.writeLock()
+
+    try {
+      const helia = this
+      const blockstore = this.blockstore.unwrap()
+
+      await drain(blockstore.deleteMany((async function * () {
+        for await (const cid of blockstore.queryKeys({})) {
+          if (await helia.pins.isPinned(cid, options)) {
+            continue
+          }
+
+          yield cid
+
+          options.onProgress?.(new CustomProgressEvent('helia:gc:deleted', cid))
+        }
+      }())))
+    } finally {
+      releaseLock()
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,94 @@
+/**
+ * @packageDocumentation
+ *
+ * Create a Helia node.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createLibp2p } from 'libp2p'
+ * import { MemoryDatastore } from 'datastore-core'
+ * import { MemoryBlockstore } from 'blockstore-core'
+ * import { createHelia } from 'helia'
+ * import { unixfs } from '@helia/unixfs'
+ * import { CID } from 'multiformats/cid'
+ *
+ * const node = await createHelia({
+ *   blockstore: new MemoryBlockstore(),
+ *   datastore: new MemoryDatastore(),
+ *   libp2p: await createLibp2p({
+ *     //... libp2p options
+ *   })
+ * })
+ * const fs = unixfs(node)
+ * fs.cat(CID.parse('bafyFoo'))
+ * ```
+ */
+
+import type { Helia } from '@helia/interface'
+import type { Libp2p } from '@libp2p/interface-libp2p'
+import type { Blockstore } from 'interface-blockstore'
+import type { Datastore } from 'interface-datastore'
+import type { CID } from 'multiformats/cid'
+import type { MultihashHasher } from 'multiformats/hashes/interface'
+import { HeliaImpl } from './helia.js'
+
+/**
+ * DAGWalkers take a block and yield CIDs encoded in that block
+ */
+export interface DAGWalker {
+  codec: number
+  walk: (block: Uint8Array) => AsyncGenerator<CID, void, undefined>
+}
+
+/**
+ * Options used to create a Helia node.
+ */
+export interface HeliaInit {
+  /**
+   * A libp2p node is required to perform network operations
+   */
+  libp2p: Libp2p
+
+  /**
+   * The blockstore is where blocks are stored
+   */
+  blockstore: Blockstore
+
+  /**
+   * The datastore is where data is stored
+   */
+  datastore: Datastore
+
+  /**
+   * By default sha256, sha512 and identity hashes are supported for
+   * bitswap operations. To bitswap blocks with CIDs using other hashes
+   * pass appropriate MultihashHashers here.
+   */
+  hashers?: MultihashHasher[]
+
+  /**
+   * In order to pin CIDs that correspond to a DAG, it's necessary to know
+   * how to traverse that DAG.  DAGWalkers take a block and yield any CIDs
+   * encoded within that block.
+   */
+  dagWalkers?: DAGWalker[]
+
+  /**
+   * Pass `false` to not start the helia node
+   */
+  start?: boolean
+}
+
+/**
+ * Create and return a Helia node
+ */
+export async function createHelia (init: HeliaInit): Promise<Helia> {
+  const helia = new HeliaImpl(init)
+
+  if (init.start !== false) {
+    await helia.start()
+  }
+
+  return helia
+}