@helia/http

@helia/http

A lightweight implementation of IPFS over HTTP in JavaScript

About

Exports a withHTTP function configures a Helia node that with block brokers and gateways that only run 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 { withHTTP } from '@helia/http'
import { unixfs } from '@helia/unixfs'
import { createHeliaLight } from 'helia'
import { CID } from 'multiformats/cid'

const helia = await withHTTP(createHeliaLight(), {
  delegatedRouters: [
    'https://delegated-ipfs.dev'
  ],
  recursiveGateways: [
    'https://trustless-gateway.link',
    'https://4everland.io'
  ]
}).start()

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

Example - without using this module

It's possible to manually configure your node without using this module.

import { createHeliaLight } from 'helia'
import { trustlessGatewayBlockBroker } from '@helia/trustless-gateway-client'
import { fallbackRouter } from '@helia/fallback-router'
import { delegatedHTTPRouter } from '@helia/delegated-http-routing-client'
import { unixfs } from '@helia/unixfs'
import { CID } from 'multiformats/cid'

const helia = await createHeliaLight({
  blockBrokers: [
    trustlessGatewayBlockBroker()
  ],
  routers: [
    delegatedHTTPRouter({
      url: 'https://delegated-ipfs.dev'
    }),
    fallbackRouter({
      gateways: ['https://trustless-gateway.link', 'https://4everland.io']
    })
  ]
}).start()

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

Install

$ npm i @helia/http

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>

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.