2.0.0Installable via npm install --save ipfs-bitswap, it can also be used directly in the browser.
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')
ipfs-bitswap should work in any ECMAScript 2018 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
JavaScript implementation of the Bitswap 'data exchange' protocol used by IPFS.
void:
void:
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.
(AsyncIterator<CID>)
(Object
= {})
| Name | Description |
|---|---|
options.abortSignal AbortSignal
|
Promise<AsyncIterator<Block>>:
Removes the given CIDs from the wantlist independent of any ref counts.
This will cause all outstanding promises for a given block to reject.
If you want to cancel the want for a block without doing that, pass an
AbortSignal in to .get or .getMany and abort it.
(Iterable<CID>)
void:
Removes the given keys from the want list. This may cause pending promises
for blocks to never resolve. If you wish these promises to abort instead
call unwant(cids) instead.
(Iterable<CID>)
void:
Put the given blocks to the underlying blockstore and send it to nodes that have it them their wantlist.
(AsyncIterable<Block>)
AsyncIterable<Block>:
Sends notifications about the arrival of a block
(Block)
Get the current list of wants.
Iterator<WantlistEntry>:
Get the current list of partners.
Iterator<PeerId>:
Start the bitswap node.
void:
Stop the bitswap node.
void:
Find providers given a cid.
(CID)
(number)
(Object
= {})
| Name | Description |
|---|---|
options.abortSignal AbortSignal
|
AsyncIterable<PeerInfo>:
Find the providers of a given cid and connect to them.
(CID)
(Object)
| Name | Description |
|---|---|
options.abortSignal AbortSignal
|
void:
Tell the network we can provide content for the passed CID
(CID)
(Object)
| Name | Description |
|---|---|
options.abortSignal AbortSignal
|
Promise<void>:
Connects to another peer
((PeerId | Multiaddr))
(Object)
| Name | Description |
|---|---|
options.abortSignal AbortSignal
|
Promise<Connection>:
Type: Object
Type: Object
(function (task, tasksWithTopic))
: given the existing
tasks with the same topic, does the task add some new information?
Used to decide whether to merge the task or ignore it.
(function (task, existingTask))
: merge the information from
the given task into the existing task (with the same topic)
The task merger that is used by default. Assumes that new tasks do not add any information over existing tasks, and doesn't try to merge.
Queue of requests to be processed by the engine. The requests from each peer are added to the peer's queue, sorted by priority. Tasks are popped in priority order from the best peer - see popTasks() for more details.
(TaskMerger)
Choose the peer with the least active work (or if all have the same active work, the most pending tasks) and pop off the highest priority tasks until the total size is at least targetMinBytes. This puts the popped tasks into the "active" state, meaning they are actively being processed (and cannot be modified).
(number)
the minimum total size of tasks to pop
Object:
Queue of tasks for a particular peer, sorted by priority.
(PeerId)
(TaskMerger)
Push tasks onto the queue.
Queue of pending tasks for a particular peer, sorted by priority.
SortedMap is a Map whose iterator order can be defined by the user
Extends Map
(Array<k, v>?)
(function (a, b)?)
compares
[k1, v1]
to
[k2, v2]
Call update to update the position of the key when it should change. For example if the compare function sorts by the priority field, and the priority changes, call update. Call indexOf() to get the index before the change happens.
(Object)
the index of entry whose position should be updated.
Is equal for Maps of BitswapMessageEntry or Blocks
boolean: