@helia/http

A lightweight implementation of IPFS over HTTP in JavaScript

About

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 and blocks are fetched from Trustless Gateways.

Pass it to other modules like @helia/unixfs to fetch files from the distributed web.

Example

import { createHeliaHTTP } from '@helia/http'
import { unixfs } from '@helia/unixfs'
import { CID } from 'multiformats/cid'

const helia = await createHeliaHTTP()

const fs = unixfs(helia)
fs.cat(CID.parse('bafyFoo'))
Copy

Example - with custom gateways and delegated routing endpoints

import { createHeliaHTTP } from '@helia/http'
import { trustlessGateway } from '@helia/block-brokers'
import { delegatedHTTPRouting, httpGatewayRouting } from '@helia/routers'
import { unixfs } from '@helia/unixfs'
import { CID } from 'multiformats/cid'

const helia = await createHeliaHTTP({
  blockBrokers: [
    trustlessGateway()
  ],
  routers: [
    delegatedHTTPRouting('https://delegated-ipfs.dev'),
    httpGatewayRouting({
      gateways: ['https://cloudflare-ipfs.com', 'https://ipfs.io']
    })
  ]
})

const fs = unixfs(helia)
fs.cat(CID.parse('bafyFoo'))
Copy

Install

$ npm i @helia/http
Copy

Browser <script> tag

Loading this module through a script tag will make its exports available as HeliaHttp in the global namespace.

<script src="https://unpkg.com/@helia/http/dist/index.min.js"></script>
Copy

Helia-http

API Docs

• https://ipfs.github.io/helia/modules/_helia_http.html

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.