ipfs-bitswap 0.26.1 | Documentation

ipfs-bitswap

0.26.1

Intro
Bitswap ▸
- Instance members
- #enableStats
- #disableStats
- #wantlistForPeer
- #ledgerForPeer
- #get
- #getMany
- #unwant
- #cancelWants
- #put
- #putMany
- #getWantlist
- #peers
- #stat
- #start
- #stop
findProviders
findAndConnect
connectTo
isMapEqual

Intro

Installable via npm install --save ipfs-bitswap, it can also be used directly in the browser.

Download

The source is available for download from GitHub. Alternatively, you can install using npm:

$ npm install --save ipfs-bitswap

You can then require() ipfs-bitswap as normal:

const ipfsBitswap = require('ipfs-bitswap')

In the Browser

Ipfs-bitswap should work in any ES2015 environment out of the box.

Usage:

<script type="text/javascript" src="index.js"></script>

The portable versions of ipfs-bitswap, including index.js and index.min.js, are included in the /dist folder. Ipfs-bitswap can also be found on unpkg.com under

Bitswap

src/index.js

JavaScript implementation of the Bitswap 'data exchange' protocol used by IPFS.

new Bitswap(libp2p: Libp2p, blockstore: Blockstore, options: Object)

Parameters

libp2p (Libp2p)

blockstore (Blockstore)

options (Object)

Instance Members

▸ enableStats()

src/index.js

enableStats(): void

Returns

void:

▸ disableStats()

src/index.js

disableStats(): void

Returns

void:

▸ wantlistForPeer(peerId)

src/index.js

Return the current wantlist for a given peerId

wantlistForPeer(peerId: PeerId): Map

Parameters

peerId (PeerId)

Returns

Map:

▸ ledgerForPeer(peerId)

src/index.js

Return ledger information for a given peerId

ledgerForPeer(peerId: PeerId): Object

Parameters

peerId (PeerId)

Returns

Object:

▸ get(cid)

src/index.js

Fetch a given block by cid. If the block is in the local blockstore it is returned, otherwise the block is added to the wantlist and returned once another node sends it to us.

get(cid: CID): Promise<Block>

Parameters

cid (CID)

Returns

Promise<Block>:

▸ getMany(cids)

src/index.js

Fetch a a list of blocks by cid. If the blocks are in the local blockstore they are returned, otherwise the blocks are added to the wantlist and returned once another node sends them to us.

getMany(cids: Iterable<CID>): Promise<AsyncIterator<Block>>

Parameters

cids (Iterable<CID>)

Returns

Promise<AsyncIterator<Block>>:

▸ unwant(cids)

src/index.js

Removes the given CIDs from the wantlist independent of any ref counts

unwant(cids: Iterable<CID>): void

Parameters

cids (Iterable<CID>)

Returns

void:

▸ cancelWants(cids)

src/index.js

Removes the given keys from the want list

cancelWants(cids: Iterable<CID>): void

Parameters

cids (Iterable<CID>)

Returns

void:

▸ put(block)

src/index.js

Put the given block to the underlying blockstore and send it to nodes that have it in their wantlist.

put(block: Block): Promise<void>

Parameters

block (Block)

Returns

Promise<void>:

▸ putMany(blocks)

src/index.js

Put the given blocks to the underlying blockstore and send it to nodes that have it them their wantlist.

putMany(blocks: (AsyncIterable<Block> | Iterable<Block>)): Promise<void>

Parameters

blocks ((AsyncIterable<Block> | Iterable<Block>))

Returns

Promise<void>:

▸ getWantlist()

src/index.js

Get the current list of wants.

getWantlist(): Iterator<WantlistEntry>

Returns

Iterator<WantlistEntry>:

▸ peers()

src/index.js

Get the current list of partners.

peers(): Iterator<PeerId>

Returns

Iterator<PeerId>:

▸ stat()

src/index.js

Get stats about the bitswap node.

stat(): Object

Returns

Object:

▸ start()

src/index.js

Start the bitswap node.

start(): void

Returns

void:

▸ stop()

src/index.js

Stop the bitswap node.

stop(): void

Returns

void:

findProviders

src/network.js

Find providers given a cid.

findProviders(cid: CID, maxProviders: number): Promise<Result<Array>>

Parameters

cid (CID)

maxProviders (number)

Returns

Promise<Result<Array>>:

findAndConnect

src/network.js

Find the providers of a given cid and connect to them.

findAndConnect(cid: CID): void

Parameters

cid (CID)

Returns

void:

connectTo

src/network.js

Connects to another peer

connectTo(peer: (PeerInfo | PeerId | Multiaddr)): Promise<Connection>

Parameters

peer ((PeerInfo | PeerId | Multiaddr))

Returns

Promise<Connection>:

isMapEqual

src/utils.js

Is equal for Maps of BitswapMessageEntry or Blocks

isMapEqual

Parameters

a (Map)

b (Map)

Returns

boolean: