ipfs-grpc-client

⛔️ DEPRECATED: js-IPFS has been superseded by Helia

📚 Learn more about this deprecation or how to migrate

⚠️ If you continue using this repo, please note that security fixes will not be provided

ipfs-grpc-client

A client library for the IPFS gRPC API

Table of contents

• Install
  • Browser <script> tag
• Why?
• API
  • create([options])
  • Parameters
  • Options
  • Returns
  • Example
• License
• Contribute

Install

$ npm i ipfs-grpc-client

Browser <script> tag

Loading this module through a script tag will make it's exports available as IpfsGrpcClient in the global namespace.

<script src="https://unpkg.com/ipfs-grpc-client/dist/index.min.js"></script>

This module implements part of the IPFS Core API using gRPC over websockets to achieve the bidirectional streaming necessary to have full duplex streams running in the browser.

It's not recommended you use this directly, instead use the ipfs-client to combine this with the ipfs-http-client in order to have HTTP fallback for the missing parts of the API.

Why?

The fetch and XHR APIs do not allow for full-duplex streaming, that is, allowing the client to receive bytes from the response while also adding more bytes to the outgoing request.

This limits what we can do in browsers in terms of the API, for example streaming arbitrarily sized payloads or exposing libp2p duplex streams.

gPRC over websockets has no such limitations so allows us to harness the full power of a remote IPFS node in the browser without the need to work around browser behaviour.

API

create([options])

Parameters

None

Options

An optional object which may have the following keys:

Name	Type	Default	Description
url	Multiaddr or string or URL	undefined	The address of a ipfs-grpc-server to connect to
agent	http.Agent	undefined	A http.Agent used to control HTTP client behaviour (node.js only)

Returns

Type	Description
object	An instance of the client

Example

import { create } from 'ipfs-gprc-client'

const client = create({
  url: '/ipv4/127.0.0.1/tcp/1234/ws'
})

const id = await client.id()

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.