-
Notifications
You must be signed in to change notification settings - Fork 901
/
doc.go
18 lines (18 loc) · 1.03 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Package p2p provides p2p functionality that powers the share exchange protocols used by celestia-node.
// The available protocols are:
//
// - shrexsub : a floodsub-based pubsub protocol that is used to broadcast/subscribe to the event
// of new EDS in the network to peers.
//
// - shrexnd: a request/response protocol that is used to request shares by namespace or namespace data from peers.
//
// - shrexeds: a request/response protocol that is used to request extended data square shares from peers.
// This protocol exchanges the original data square in between the client and server, and it's up to the
// receiver to compute the extended data square.
//
// This package also defines a peer manager that is used to manage network peers that can be used to exchange
// shares. The peer manager is primarily responsible for providing peers to request shares from,
// and is primarily used by `getters.ShrexGetter` in share/getters/shrex.go.
//
// Find out more about each protocol in their respective sub-packages.
package p2p