godoc package documentation (#1152)

pkg/accounting/accounting.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package accounting provides functionalities needed
+// to do per-peer accounting.
 package accounting
 
 import (

pkg/accounting/mock/accounting.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package mock provides a mock implementation for the
+// accounting interface.
 package mock
 
 import (

pkg/api/api.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package api provides the functionality of the Bee
+// client-facing HTTP API.
 package api
 
 import (

pkg/bitvector/bitvector.go

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
 
+// Package bitvector provides functionality of a
+// simple bit vector implementation.
 package bitvector
 
 import (

pkg/bmtpool/bmtpool.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package bmtpool provides easy access to binary
+// merkle tree hashers managed in as a resource pool.
 package bmtpool
 
 import (

pkg/bzz/address.go

@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package bzz exposes the data structure and operations
+// necessary on the bzz.Address type which used in the handshake
+// protocol, address-book and hive protocol.
 package bzz
 
 import (

pkg/content/validator.go

@@ -2,6 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package content exposes content-addressed validation.
 package content
 
 import (

pkg/debugapi/debugapi.go

@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package debugapi exposes the debug API used to
+// control and analyze low-level and runtime
+// features and functionalities of Bee.
 package debugapi
 
 import (

pkg/discovery/discovery.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package discovery exposes the discovery driver interface
+// which is implemented by discovery protocols.
 package discovery
 
 import (

pkg/encryption/encryption.go

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
 
+// Package encryption exposes functionalities needed for
+// encryption and decryption operations in Bee.
 package encryption
 
 import (

pkg/hive/hive.go

@@ -2,6 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package hive exposes the hive protocol implementation
+// which is the discovery protocol used to inform and be
+// informed about other peers in the network. It gossips
+// about all peers by default and performs no specific
+// prioritization about which peers are gossipped to
+// others.
 package hive
 
 import (

pkg/intervalstore/intervals.go

@@ -14,6 +14,11 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
 
+// Package intervalstore provides a persistence layer
+// for intervals relating to a peer. The store
+// provides basic operation such as adding intervals to
+// existing ones and persisting the results, as well as
+// getting next interval for a peer.
 package intervalstore
 
 import (

pkg/jsonhttp/jsonhttp.go

@@ -4,6 +4,8 @@
 
 // Most of the code is copied from package resenje.org/jsonresponse.
 
+// Package jsonhttp provides convenience methods to
+// provide better JSON HTTP APIs.
 package jsonhttp
 
 import (

pkg/logging/logging.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package logging provides the logger interface abstraction
+// and implementation for Bee. It uses logrus under the hood.
 package logging
 
 import (

pkg/manifest/manifest.go

@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package manifest contains the abstractions needed for
+// collection representation in Swarm. It uses implementations
+// in ethersphere/manifest repo under the hood.
 package manifest
 
 import (

pkg/netstore/netstore.go

@@ -2,6 +2,10 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package netstore provides an abstraction layer over the
+// Swarm local storage layer that leverages connectivity
+// with other peers in order to retrieve chunks from the network that cannot
+// be found locally.
 package netstore
 
 import (

pkg/node/node.go

@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package node defines the concept of a Bee node
+// by bootstrapping and injecting all necessary
+// dependencies.
 package node
 
 import (

pkg/p2p/p2p.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package p2p provides the peer-to-peer abstractions used
+// across different protocols in Bee.
 package p2p
 
 import (

pkg/pingpong/pingpong.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package pingpong exposes the simple ping-pong protocol
+// which measures round-trip-time with other peers.
 package pingpong
 
 import (

pkg/pss/pss.go

@@ -2,6 +2,11 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package pss exposes functionalities needed to communicate
+// with other peers on the network. Pss uses pushsync and
+// pullsync for message delivery and mailboxing. All messages are disguised as content-addressed chunks. Sending and
+// receiving of messages is exposed over the HTTP API, with
+// websocket subscriptions for incoming messages.
 package pss
 
 import (

pkg/puller/puller.go

@@ -2,6 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package puller provides protocol-orchestrating functionality
+// over the pullsync protocol. It pulls chunks from other nodes
+// and reacts to changes in network configuration.
 package puller
 
 import (

pkg/pullsync/pullsync.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package pullsync provides the pullsync protocol
+// implementation.
 package pullsync
 
 import (

pkg/pusher/pusher.go

@@ -2,6 +2,10 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package pusher provides protocol-orchestrating functionality
+// over the pushsync protocol. It makes sure that chunks meant
+// to be distributed over the network are sent used using the
+// pushsync protocol.
 package pusher
 
 import (

pkg/pushsync/pushsync.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package pushsync provides the pushsync protocol
+// implementation.
 package pushsync
 
 import (

pkg/retrieval/retrieval.go

@@ -2,6 +2,10 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package retrieval provides the retrieval protocol
+// implementation. The protocol is used to retrieve
+// chunks over the network using forwarding-kademlia
+// routing.
 package retrieval
 
 import (

pkg/sctx/sctx.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.package storage
 
+// Package sctx provides convenience methods for context
+// value injection and extraction.
 package sctx
 
 import (

pkg/soc/soc.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package soc provides the single-owner chunk implemenation
+// and validator.
 package soc
 
 import (

pkg/statestore/doc.go

+// Copyright 2021 The Swarm Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package statestore provides statestore implementation
+// and mock. It uses leveldb under the hood.
+package statestore

pkg/storage/store.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.package storage
 
+// Package storage provides implementation contracts and notions
+// used across storage-aware components in Bee.
 package storage
 
 import (

pkg/tags/tags.go

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
 
+// Package tags provides the implementation for
+// upload progress tracking.
 package tags
 
 import (

pkg/topology/topology.go

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package topology exposes abstractions needed in
+// topology-aware components.
 package topology
 
 import (

pkg/traversal/traversal.go

@@ -2,6 +2,10 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package traversal provides abstraction and implementation
+// needed to traverse all chunks below a given root hash.
+// It tries to parse all manifests and collections in its
+// attempt to log all chunk addresses on the way.
 package traversal
 
 import (