svetomir/bee repository overview

⁠Ethereum Swarm Bee

This is an experiment to abstract libp2p as underlay networking for Ethereum Swarm.

Work in progress. This is not the final abstraction.

⁠Install

make binary
cp dist/bee /usr/local/bin/bee

⁠Usage (experimental api)

Execute the command terminals to start node 1:

bee start --api-addr :8501 --p2p-addr :30401 --data-dir data1

Use one of the multiaddresses as bootnode for node 2 in order to connect them:

bee start --api-addr :8502 --p2p-addr :30402 --data-dir data2 --bootnode /ip4/127.0.0.1/tcp/30401/p2p/QmT4TNB4cKYanUjdYodw1Cns8cuVaRVo24hHNYcT7JjkTB

Take the address of the connected peer to node 1 from log line peer "4932309428148935717" connected and make an HTTP POST request to localhost:{PORT1}/pingpong/{ADDRESS} like:

curl -XPOST localhost:8502/pingpong/4932309428148935717

⁠Structure

• cmd/bee - a simple application integrating p2p and pingpong service
• pkg/api - a simple http api exposing pingpong endpoint
• pkg/p2p - p2p abstraction
• pkg/p2p/libp2p - p2p implementation using libp2p
• pkg/p2p/mock - p2p protocol testing tools
• pkg/p2p/protobuf - protobuf message encoding and decoding functions
• pkg/pingpong - p2p protocol implementation example

⁠Restrictions

• Package pkg/p2p only contains generalized abstraction of p2p protocol. It does not impose stream encoding.
• Package pkg/p2p/libp2p and is only allowed to depend on go-libp2p packages given that it is just one pkg/p2p implementation. No other implementation should depend on go-libp2p packages.
• Package pkg/p2p/protobuf provides all the helpers needed to make easer for protocol implementations to use protocol buffers for encoding.

⁠TODO

• P2P mock (protocol tester) implementation improvements
• Figure out routing (whether to use libp2p Routing or to abstract hive on top of p2p package)
• Instrumentation: logging, metrics, tracing, pprof...