opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-07-01 02:30:39 +08:00
Code Issues Projects Releases Wiki Activity

update bitswap readme

Browse Source
This commit is contained in:
Jeromy
2014-12-04 21:38:40 +00:00
parent f054be9e1f
commit afa28dc672
1 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
exchange/bitswap/README.md
View File

@ -1,22 +1,24 @@
#Welcome to Bitswap #Welcome to Bitswap (The data trading engine)
Bitswap is the module that is responsible for requesting blocks over the Bitswap is the module that is responsible for requesting and providing data
network from other ipfs peers. blocks over the network to and from other ipfs peers. The role of bitswap is
to be a merchant in the large global marketplace of data.
##Main Operations ##Main Operations
Bitswap has three main operations: Bitswap has three high level operations:
###GetBlocks ###GetBlocks
`GetBlocks` is a bitswap method used to request multiple blocks that are likely `GetBlocks` is a bitswap method used to request multiple blocks that are likely
to all be provided by the same peer (part of a single file, for example). to all be provided by the same set of peers (part of a single file, for example).
###GetBlock ###GetBlock
`GetBlock` is a special case of `GetBlocks` that just requests a single block. `GetBlock` is a special case of `GetBlocks` that just requests a single block.
###HasBlock ###HasBlock
`HasBlock` registers a local block with bitswap. Bitswap will then send that `HasBlock` registers a local block with bitswap. Bitswap will then send that
block to any connected peers who want it (strategy allowing), and announce to block to any connected peers who want it (with the strategies approval), record
the DHT that the block is being provided. that transaction in the ledger and announce to the DHT that the block is being
provided.
##Internal Details ##Internal Details
All `GetBlock` requests are relayed into a single for-select loop via channels. All `GetBlock` requests are relayed into a single for-select loop via channels.
@ -39,4 +41,6 @@ If another peers wantlist is received, Bitswap will call its strategies
be sent the block they are requesting (if we even have it). be sent the block they are requesting (if we even have it).
##Outstanding TODOs: ##Outstanding TODOs:
- Ensure only one request active per key [] Ensure only one request active per key
[] More involved strategies
[] Ensure only wanted blocks are counted in ledgers