Document bitswap

[jbenet]

Hey @dignifiedquire i have some questions re impl. Forgive silliness, first time i look at it.

1. why is bitswap block key going to hex in the proto msg? it should be straight binary -- https://github.com/ipfs/js-ipfs-bitswap/blob/master/src/message/index.js#L48
2. why bitswap.stop has this.network.start() https://github.com/ipfs/js-ipfs-bitswap/blob/master/src/index.js#L276
3. why bitswap.network uses bl? isnt this wasteful? is it caching all buffers? (i've only glanced at bl, havent used it) https://github.com/ipfs/js-ipfs-bitswap/blob/master/src/network/index.js#L40
4. provierRequestTimeout spelling - https://github.com/ipfs/js-ipfs-bitswap/blob/master/src/constants.js#L7

[dignifiedquire]

Nothing to forgive,

1. Actually it is not, as far as I understand go-bitswap casts the key to a string on the conversion to protobuf, which results in a conversion to base58
2. cough typo *cough
3. it's buffering up a single message, which we have to because the protocol-buffer parser we are using can only parse a complete message
4. I like that spelling :)

[daviddias]

Actually it is not, as far as I understand go-bitswap casts the key to a string on the conversion to protobuf, which results in a conversion to base58

Still, not hex. Still you catched a bunch of these in your PR, but miss this one -> https://github.com/ipfs/js-ipfs-bitswap/pull/17/files#diff-e4c2bb9741805e47edd01ae04b0894b5R52

[dignifiedquire]

still, not hex. Still you catched a bunch of these in your PR, but miss this one

yes correct

[jbenet]

Actually it is not, as far as I understand go-bitswap casts the key to a string on the conversion to protobuf, which results in a conversion to base58

I don't think this https://github.com/ipfs/go-ipfs/blob/master/exchange/bitswap/message/message.go#L156 calls https://github.com/ipfs/go-ipfs/blob/master/blocks/key/key.go#L16-L18 -- i think the keys are sent as straight up binary. calling string(buf) only casts to string, does not call .String(). cc @whyrusleeping

it's buffering up a single message, which we have to because the protocol-buffer parser we are using can only parse a complete message

ok so only one message? it releases the previous messages?

[daviddias]

There is now a bit more documentation of Bitswap - https://github.com/ipfs/js-ipfs-bitswap#development

A lot came from this PR - #76 pointing it here for context