MCPcopy Index your code
hub / github.com/ethersphere/bee

github.com/ethersphere/bee @v2.8.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v2.8.0 ↗ · + Follow
7,381 symbols 38,427 edges 852 files 2,597 documented · 35% 1 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Swarm Bee

Go Go Reference codecov Go Report Card API OpenAPI Specs Docker Pulls GitHub all releases GitHub

DISCLAIMER

This software is provided to you "as is", use at your own risk and without warranties of any kind. It is your responsibility to read and understand how Swarm works and the implications of running this software. The usage of Bee involves various risks, including, but not limited to: damage to hardware or loss of funds associated with the Ethereum account connected to your node. No developers or entity involved will be liable for any claims and damages associated with your use, inability to use, or your interaction with other nodes or the software.

Our documentation is hosted at https://docs.ethswarm.org.

Versioning

There are two versioning schemes used in Bee that you should be aware of. The main Bee version does NOT follow strict Semantic Versioning. Bee hosts different peer-to-peer wire protocol implementations and individual protocol breaking changes would necessitate a bump in the major part of the version. Breaking changes are expected with bumps of the minor version component. New (backward-compatible) features and bug fixes are expected with a bump of the patch component. Major version bumps are reserved for significant changes in Swarm's incentive structure.

The second is the Bee's API version (denoted in our Bee OpenAPI specifications). This version follows Semantic Versioning and hence you should follow these for breaking changes.

Contributing

Please read the coding guidelines and style guide.

Installing

Install instructions

Get in touch

Only official website

License

This library is distributed under the BSD-style license found in the LICENSE file.

Extension points exported contracts — how you extend this code

LocalStore (Interface)
LocalStore is a read-only ChunkStore. It can be used to check if chunk is known locally, but it cannot tell what is the [8 …
pkg/storer/storer.go
Session (Interface)
Session represents an interface for a Diffie-Hellmann key derivation [10 implementers]
pkg/accesscontrol/session.go
AdvertisableAddressResolver (Interface)
AdvertisableAddressResolver can Resolve a Multiaddress. [10 implementers]
pkg/p2p/libp2p/internal/handshake/handshake.go
Key (Interface)
Key represents the item identifiers. [32 implementers]
pkg/storage/storage.go
ChainWriter (Interface)
ChainWriter is a writer in a pipeline. It is up to the implementer to decide whether a writer calls the next writer or n [7 …
pkg/file/pipeline/pipeline.go
Saver (Interface)
Saver defines a generic interface to persist nodes for write operations [12 implementers]
pkg/manifest/mantaray/persist.go
Index (Interface)
Index is the interface for feed implementations. [7 implementers]
pkg/feeds/feed.go
PeerIterator (Interface)
PeerIterator is an interface that allows iteration over peers. [5 implementers]
pkg/topology/topology.go

Core symbols most depended-on inside this repo

Run
called by 1329
pkg/storer/internal/transaction/transaction.go
Equal
called by 685
pkg/swarm/swarm.go
Address
called by 613
pkg/swarm/swarm.go
Error
called by 582
pkg/log/log.go
Bytes
called by 557
pkg/swarm/swarm.go
Debug
called by 526
pkg/log/log.go
Request
called by 376
pkg/jsonhttp/jsonhttptest/jsonhttptest.go
IndexStore
called by 372
pkg/storer/internal/transaction/transaction.go

Shape

Method 3,517
Function 2,671
Struct 817
Interface 235
FuncType 90
TypeAlias 51

Languages

Go100%

Modules by API surface

pkg/pullsync/pb/pullsync.pb.go123 symbols
pkg/storer/storer.go79 symbols
pkg/p2p/libp2p/internal/handshake/pb/handshake.pb.go78 symbols
pkg/p2p/p2p.go66 symbols
pkg/accounting/accounting.go66 symbols
pkg/swarm/swarm.go63 symbols
pkg/p2p/libp2p/libp2p.go63 symbols
pkg/p2p/libp2p/connections_test.go62 symbols
pkg/topology/kademlia/kademlia.go59 symbols
pkg/storage/storage.go54 symbols
pkg/storage/storagetest/benchmark.go51 symbols
pkg/postage/listener/listener_test.go51 symbols

Used by 1 indexed graphs manifest dependencies, hub-wide

For agents

$ claude mcp add bee \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact