Skip to content

Commit

Permalink
fix: update project deps and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
achingbrain committed Feb 28, 2024
1 parent 6f8c15b commit 77e34fc
Show file tree
Hide file tree
Showing 77 changed files with 344 additions and 4,967 deletions.
3 changes: 1 addition & 2 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,5 @@
"packages/unixfs": "3.0.0",
"packages/utils": "0.0.1",
"packages/http": "1.0.1",
"packages/routers": "1.0.0",
"packages/verified-fetch": "0.0.0"
"packages/routers": "1.0.0"
}
3 changes: 1 addition & 2 deletions .release-please.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"packages/routers": {},
"packages/strings": {},
"packages/unixfs": {},
"packages/utils": {},
"packages/verified-fetch": {}
"packages/utils": {}
}
}
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,29 +167,31 @@ The basic Helia API is defined in:

The API is implemented by:

- [`/packages/helia`](./packages/helia) An implementation of the Helia API
- [`/packages/helia`](./packages/helia) An peer to peer implementation that uses [bitswap](https://docs.ipfs.tech/concepts/bitswap/), [libp2p](https://www.npmjs.com/package/libp2p) and [HTTP gateways](https://docs.ipfs.tech/reference/http/gateway/) as fallback
- [`/packages/http`](./packages/http) A lightweight implementation that uses [HTTP gateways](https://docs.ipfs.tech/reference/http/gateway/) exclusively

Helia also ships a number of supplemental libraries and tools.
Helia also ships a number of supplemental libraries and tools that can be combined with Helia API implementations to accomplish tasks in distributed and trustless ways.

These libraries are not intended to be the "one true implementation" of any given API, but are made available for users to include depending on the need of their particular application:

- [./packages/unixfs](./packages/unixfs) The `@helia/unixfs` module
- [./packages/car](./packages/car) The `@helia/car` module
- [./packages/dag-cbor](./packages/dag-cbor) The `@helia/dag-cbor` module
- [./packages/dag-json](./packages/dag-json) The `@helia/dag-json` module
- [./packages/ipns](./packages/ipns) The `@helia/ipns` module
- [./packages/json](./packages/json) The `@helia/json` module
- [./packages/mfs](./packages/mfs) The `@helia/mfs` module
- [./packages/ipns](./packages/ipns) `@helia/ipns`
- [./packages/car](./packages/car) `@helia/car`
- [./packages/strings](./packages/strings) `@helia/strings`
- [./packages/json](./packages/json) `@helia/json`
- [./packages/dag-json](./packages/dag-json) `@helia/dag-json`
- [./packages/dag-cbor](./packages/dag-cbor) `@helia/dag-cbor`
- [./packages/strings](./packages/strings) The `@helia/strings` module
- [./packages/unixfs](./packages/unixfs) The `@helia/unixfs` module

An interface suite ensures everything is compatible:
An interop suite ensures everything is compatible:

- [`/packages/interop`](./packages/interop) Interop tests for Helia

## Other modules

There are several other modules available outside this repo:

- [`@helia/verified-fetch`](https://github.com/ipfs/helia-verified-fetch) A [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)-like API for retrieving trustless, verified content from the distributed web
- [`@helia/delegated-routing-v1-http-api`](https://github.com/ipfs/helia-delegated-routing-v1-http-api) An implementation of the [Delegated Routing v1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/) including a server and a client
- [Helia WNFS](https://github.com/shovelers/helia-wnfs) a [WNFS](https://guide.fission.codes/developers/webnative/file-system-wnfs) implementation built on top of Helia
- [`@helia/remote-pinning`](https://github.com/ipfs/helia-remote-pinning) A Helia client for communicating with [IPFS Pinning Services](https://ipfs.github.io/pinning-services-api-spec/)
Expand Down
2 changes: 2 additions & 0 deletions packages/block-brokers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
</a>
</p>

# @helia/block-brokers

[![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)
Expand Down
10 changes: 5 additions & 5 deletions packages/block-brokers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,16 @@
},
"dependencies": {
"@helia/interface": "^4.0.0",
"@libp2p/interface": "^1.1.2",
"interface-blockstore": "^5.2.9",
"@libp2p/interface": "^1.1.3",
"interface-blockstore": "^5.2.10",
"ipfs-bitswap": "^20.0.2",
"multiformats": "^13.0.1",
"multiformats": "^13.1.0",
"progress-events": "^1.0.0"
},
"devDependencies": {
"@libp2p/logger": "^4.0.5",
"@libp2p/logger": "^4.0.6",
"@types/sinon": "^17.0.3",
"aegir": "^42.2.2",
"aegir": "^42.2.5",
"sinon": "^17.0.1",
"sinon-ts": "^2.0.0"
}
Expand Down
15 changes: 15 additions & 0 deletions packages/car/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@
# About

<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->

`@helia/car` provides `import` and `export` methods to read/write Car files to Helia's blockstore.

See the Car interface for all available operations.
Expand Down
10 changes: 5 additions & 5 deletions packages/car/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -140,20 +140,20 @@
},
"dependencies": {
"@helia/interface": "^4.0.0",
"@ipld/car": "^5.2.6",
"@ipld/car": "^5.3.0",
"@libp2p/interfaces": "^3.3.2",
"interface-blockstore": "^5.2.9",
"interface-blockstore": "^5.2.10",
"it-drain": "^3.0.5",
"it-map": "^3.0.5",
"multiformats": "^13.0.1",
"multiformats": "^13.1.0",
"p-defer": "^4.0.0",
"p-queue": "^8.0.1",
"progress-events": "^1.0.0"
},
"devDependencies": {
"@helia/unixfs": "^3.0.0",
"@ipld/dag-pb": "^4.0.8",
"aegir": "^42.2.2",
"@ipld/dag-pb": "^4.1.0",
"aegir": "^42.2.5",
"blockstore-core": "^4.4.0",
"ipfs-unixfs-importer": "^15.2.4",
"it-to-buffer": "^4.0.5"
Expand Down
15 changes: 15 additions & 0 deletions packages/dag-cbor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@
# About

<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->

`@helia/dag-cbor` makes working with DAG-JSON Helia simple & straightforward.

See the DAGCBOR interface for all available operations.
Expand Down
8 changes: 4 additions & 4 deletions packages/dag-cbor/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -141,14 +141,14 @@
},
"dependencies": {
"@helia/interface": "^4.0.0",
"@ipld/dag-cbor": "^9.1.0",
"@ipld/dag-cbor": "^9.2.0",
"@libp2p/interfaces": "^3.3.2",
"interface-blockstore": "^5.2.9",
"multiformats": "^13.0.1",
"interface-blockstore": "^5.2.10",
"multiformats": "^13.1.0",
"progress-events": "^1.0.0"
},
"devDependencies": {
"aegir": "^42.2.2",
"aegir": "^42.2.5",
"blockstore-core": "^4.4.0"
}
}
15 changes: 15 additions & 0 deletions packages/dag-json/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@
# About

<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->

`@helia/dag-json` makes working with DAG-JSON Helia simple & straightforward.

See the DAGJSON interface for all available operations.
Expand Down
8 changes: 4 additions & 4 deletions packages/dag-json/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -140,14 +140,14 @@
},
"dependencies": {
"@helia/interface": "^4.0.0",
"@ipld/dag-json": "^10.1.7",
"@ipld/dag-json": "^10.2.0",
"@libp2p/interfaces": "^3.3.2",
"interface-blockstore": "^5.2.9",
"multiformats": "^13.0.1",
"interface-blockstore": "^5.2.10",
"multiformats": "^13.1.0",
"progress-events": "^1.0.0"
},
"devDependencies": {
"aegir": "^42.2.2",
"aegir": "^42.2.5",
"blockstore-core": "^4.4.0"
}
}
17 changes: 17 additions & 0 deletions packages/helia/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
</a>
</p>

# helia

[![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)
Expand All @@ -13,6 +15,21 @@
# About

<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->

Exports a `createHelia` function that returns an object that implements the Helia API.

Pass it to other modules like @helia/unixfs to make files available on the distributed web.
Expand Down
48 changes: 24 additions & 24 deletions packages/helia/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,41 +55,41 @@
},
"dependencies": {
"@chainsafe/libp2p-noise": "^15.0.0",
"@chainsafe/libp2p-yamux": "^6.0.1",
"@chainsafe/libp2p-yamux": "^6.0.2",
"@helia/block-brokers": "^2.0.1",
"@helia/delegated-routing-v1-http-api-client": "^3.0.0",
"@helia/interface": "^4.0.0",
"@helia/routers": "^1.0.0",
"@helia/utils": "^0.0.1",
"@libp2p/autonat": "^1.0.10",
"@libp2p/bootstrap": "^10.0.13",
"@libp2p/circuit-relay-v2": "^1.0.13",
"@libp2p/dcutr": "^1.0.10",
"@libp2p/identify": "^1.0.12",
"@libp2p/interface": "^1.1.2",
"@libp2p/kad-dht": "^12.0.5",
"@libp2p/keychain": "^4.0.7",
"@libp2p/logger": "^4.0.5",
"@libp2p/mdns": "^10.0.13",
"@libp2p/mplex": "^10.0.13",
"@libp2p/ping": "^1.0.10",
"@libp2p/tcp": "^9.0.13",
"@libp2p/upnp-nat": "^1.0.11",
"@libp2p/webrtc": "^4.0.17",
"@libp2p/websockets": "^8.0.13",
"@libp2p/webtransport": "^4.0.17",
"@libp2p/autonat": "^1.0.12",
"@libp2p/bootstrap": "^10.0.15",
"@libp2p/circuit-relay-v2": "^1.0.15",
"@libp2p/dcutr": "^1.0.12",
"@libp2p/identify": "^1.0.14",
"@libp2p/interface": "^1.1.3",
"@libp2p/kad-dht": "^12.0.7",
"@libp2p/keychain": "^4.0.8",
"@libp2p/logger": "^4.0.6",
"@libp2p/mdns": "^10.0.15",
"@libp2p/mplex": "^10.0.15",
"@libp2p/ping": "^1.0.11",
"@libp2p/tcp": "^9.0.15",
"@libp2p/upnp-nat": "^1.0.13",
"@libp2p/webrtc": "^4.0.19",
"@libp2p/websockets": "^8.0.15",
"@libp2p/webtransport": "^4.0.19",
"blockstore-core": "^4.4.0",
"datastore-core": "^9.2.7",
"interface-blockstore": "^5.2.9",
"interface-datastore": "^8.2.10",
"datastore-core": "^9.2.9",
"interface-blockstore": "^5.2.10",
"interface-datastore": "^8.2.11",
"ipns": "^9.0.0",
"libp2p": "^1.2.1",
"multiformats": "^13.0.1"
"libp2p": "^1.2.3",
"multiformats": "^13.1.0"
},
"devDependencies": {
"@multiformats/mafmt": "^12.1.6",
"@multiformats/multiaddr": "^12.1.14",
"aegir": "^42.2.2",
"aegir": "^42.2.5",
"it-all": "^3.0.4",
"it-drain": "^3.0.5"
},
Expand Down
17 changes: 17 additions & 0 deletions packages/http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
</a>
</p>

# @helia/http

[![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)
Expand All @@ -13,6 +15,21 @@
# About

<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->

Exports a `createHeliaHTTP` function that returns an object that implements a lightweight version of the Helia API that functions only over HTTP.

By default, content and peer routing are requests are resolved using the [Delegated HTTP Routing API](https://specs.ipfs.tech/routing/http-routing-v1/) and blocks are fetched from [Trustless Gateways](https://specs.ipfs.tech/http-gateways/trustless-gateway/).
Expand Down
10 changes: 5 additions & 5 deletions packages/http/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@
"@helia/routers": "^1.0.0",
"@helia/utils": "^0.0.1",
"blockstore-core": "^4.4.0",
"datastore-core": "^9.2.7"
"datastore-core": "^9.2.9"
},
"devDependencies": {
"@libp2p/interface": "^1.1.2",
"aegir": "^42.2.2",
"interface-datastore": "^8.2.10",
"multiformats": "^13.0.1",
"@libp2p/interface": "^1.1.3",
"aegir": "^42.2.5",
"interface-datastore": "^8.2.11",
"multiformats": "^13.1.0",
"sinon": "^17.0.1",
"sinon-ts": "^2.0.0"
}
Expand Down
17 changes: 17 additions & 0 deletions packages/interface/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
</a>
</p>

# @helia/interface

[![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)
Expand All @@ -13,6 +15,21 @@
# About

<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->

The API defined by a Helia node

## Example
Expand Down
Loading

0 comments on commit 77e34fc

Please sign in to comment.