@hyperspace/client

Standalone Hyperspace RPC client

npm install @hyperspace/client

Usage

const HyperspaceClient = require('@hyperspace/client')

const client = new HyperspaceClient() // connect to the Hyperspace server

const corestore = client.corestore() // make a corestore

const feed = corestore.get(someHypercoreKey) // make a hypercore

await feed.get(42) // get some data from the hypercore

API

const client = new HyperspaceClient([options])

Make a new Hyperspace RPC client. Options include:

{
  host: 'hyperspace', // the ipc name of the running server
                      // defaults to hyperspace
  port                // a TCP port to connect to
}

If port is specified, or host and port are both specified, then the client will attempt to connect over TCP.

If you only provide a host option, then it will be considered a Unix socket name.

await HyperspaceClient.serverReady([host])

Static method to wait for the local IPC server to be up and running.

status = await client.status([callback])

Get status of the local daemon. Includes stuff like API version etc.

await client.close([callback])

Fully close the client. Cancels all inflight requests.

await client.ready([callback])

Wait for the client to have fully connected and loaded initial data.

corestore = client.corestore([namespace])

Make a new remote corestore. Optionally you can pass a specific namespace to load a specific corestore. If you do not pass a namespace a random one is generated for you.

client.network

The remote corestore network instance.

client.replicate(core)

A one-line replication function for RemoteHypercores (see below for details).

Remote Corestore

The remote corestore instances has an API that mimicks the normal corestore API.

feed = corestore.get([key])

Make a new remote hypercore instance. If you pass a key that specific feed is loaded, if not a new one is made.

feed = corestore.default()

Get the "default" feed for this corestore, which is derived from the namespace.

feed.name

The name (namespace) of this corestore.

async feed.close([callback])

Close the corestore. Closes all feeds made in this corestore.

Remote Networker

The remote networker instance has an API that mimicks the normal corestore networker API.

await network.ready([callback])

Make sure all the peer state is loaded locally. client.ready calls this for you. Note you do not have to call this before using any of the apis, this just makes sure network.peers is populated.

networks.peers

A list of peers we are connected to.

network.on('peer-add', peer)

Emitted when a peer is added.

network.on('peer-remove', peer)

Emitted when a peer is removed.

await network.configure(discoveryKey | RemoteHypercore, options)

Configure the network for this specific discovery key or RemoteHypercore. Options include:

{
  lookup: true, // should we find peers?
  announce: true, // should we announce ourself as a peer?
  flush: true // wait for the full swarm flush before returning?
  remember: false // persist this configuration so it stays around after we close our session?
}

const ext = network.registerExtension(name, { encoding, onmessage, onerror })

Register a network protocol extension.

Remote Feed

The remote feed instances has an API that mimicks the normal Hypercore API.

feed.key

The feed public key

feed.discoveryKey

The feed discovery key.

feed.writable

Boolean indicating if this feed is writable.

await feed.ready([callback])

Wait for the key, discoveryKey, writability, initial peers to be loaded.

const block = await feed.get(index, [options], [callback])

Get a block of data from the feed.

Options include:

{
  ifAvailable: true,
  wait: false,
  onwait () { ... }
}

See the Hypercore docs for more info on these options.

Note if you don't await the promise straight away you can use it to to cancel the operation, later using feed.cancel

const p = feed.get(42)
// ... cancel the get
feed.cancel(p)
await p // Was cancelled

feed.cancel(p)

Cancel a get

await feed.has(index, [callback])

Check if the feed has a specific block

await feed.download(start, end, [callback])

Select a range to be downloaded. Similarly to feed.get you can use the promise itself to cancel a download using feed.undownload(p)

feed.undownload(p)

Stop downloading a range.

await feed.update([options], [callback])

Fetch an update for the feed.

Options include:

{
  minLength: ..., // some min length to update to
  ifAvailable: true,
  hash: true
}

See the Hypercore docs for more info on these options.

await feed.append(blockOrArrayOfBlocks, [callback])

Append a block or array of blocks to the hypercore

feed.peers

A list of peers this feed is connected to.

feed.on('peer-add', peer)

Emitted when a peer is added.

feed.on('peer-remove', peer)

Emitted when a peer is removed.

feed.on('append')

Emitted when the feed is appended to, either locally or remotely.

feed.on('download', seq, data)

Emitted when a block is downloaded. data is a pseudo-buffer with {length, byteLength} but no buffer content.

feed.on('upload', seq, data)

Emitted when a block is uploaded. data is a pseudo-buffer with {length, byteLength} but no buffer content.

Replicator

Hyperspace also includes a simple replication function for RemoteHypercores that does two things:

1. It first configures the network (client.network.configure(core, { announce: true, lookup: true }))
2. Then it does a core.update({ ifAvailable: true }) to try to fetch the latest length from the network.

This saves a bit of time when swarming a RemoteHypercore.

await replicate(core)

Quickly connect a RemoteHypercore to the Hyperswarm network.

License

MIT