Skip to content

GitLab

Commit 00404873 authored by Jeromy Johnson's avatar Jeromy Johnson Committed by Jeromy
Browse files
Options

Update README.md

parent 5512207a
Show whitespace changes
Inline Side-by-side
Showing with 11 additions and 10 deletions
README.md
View file @ 00404873
#Welcome to Bitswap (The data trading engine) #Welcome to Bitswap
###(The data trading engine)
Bitswap is the module that is responsible for requesting and providing data Bitswap is the module that is responsible for requesting and providing data
blocks over the network to and from other ipfs peers. The role of bitswap is blocks over the network to and from other ipfs peers. The role of bitswap is
...@@ -7,15 +8,15 @@ to be a merchant in the large global marketplace of data. ...@@ -7,15 +8,15 @@ to be a merchant in the large global marketplace of data.
##Main Operations ##Main Operations
Bitswap has three high level 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 set of peers (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 (with the strategies approval), record block to any connected peers who want it (with the strategies approval), record
that transaction in the ledger and announce to the DHT that the block is being that transaction in the ledger and announce to the DHT that the block is being
provided. provided.
...@@ -41,6 +42,6 @@ If another peers wantlist is received, Bitswap will call its strategies ...@@ -41,6 +42,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 - [ ] More involved strategies
[] Ensure only wanted blocks are counted in ledgers - [ ] Ensure only wanted blocks are counted in ledgers
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment