@helia/block-brokers

Block brokers for Helia

About

This module contains Helia block brokers, currently for bitswap and Trustless Gateways.

Trustless Gateway Block Broker

The TrustlessGatewayBlockBroker fetches blocks from HTTP gateways.

Example - Customizing fetch requests with custom headers

It is possible to modify outgoing requests to (for example) include authentication information (such as a JWT token in a header).

import { createHelia } from 'helia'
import { trustlessGateway } from '@helia/block-brokers'
import { unixfs } from '@helia/unixfs'
import { CID } from 'multiformats/cid'
import { concat } from 'uint8arrays/concat'
import all from 'it-all'

const helia = await createHelia({
  blockBrokers: [
    trustlessGateway({
      transformRequestInit: (requestInit) => {
        // modify the request init object as required
        requestInit.headers = {
          ...requestInit.headers,
          'User-Agent': 'Helia Example Script'
        }
        return requestInit
      }
    })
  ]
})

const cid = CID.parse('bafkreife2klsil6kaxqhvmhgldpsvk5yutzm4i5bgjoq6fydefwtihnesa')
const fs = unixfs(helia)

for await (const chunk of fs.cat(cid, {
  signal: AbortSignal.timeout(10_000)
})) {
  console.info(chunk)
}

Install

$ npm i @helia/block-brokers

Browser <script> tag

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

<script src="https://unpkg.com/@helia/block-brokers/dist/index.min.js"></script>

API Docs

• https://ipfs.github.io/helia/modules/_helia_block-brokers.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.