Documentation
¶
Overview ¶
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.
Index ¶
- Variables
- func AreUnderlaysEqual(a, b []ma.Multiaddr) bool
- func ContainsAddress(addrs []Address, a *Address) bool
- func DeserializeUnderlays(data []byte) ([]multiaddr.Multiaddr, error)
- func SelectBestAdvertisedAddress(addrs []ma.Multiaddr, fallback ma.Multiaddr) ma.Multiaddr
- func SerializeUnderlays(addrs []multiaddr.Multiaddr) []byte
- type Address
- type TransportType
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidAddress = errors.New("invalid address")
Functions ¶
func AreUnderlaysEqual ¶ added in v2.7.0
func ContainsAddress ¶
ContainsAddress reports whether a is present in addrs.
func DeserializeUnderlays ¶ added in v2.7.0
DeserializeUnderlays deserializes a byte slice into a slice of multiaddrs. The data format is automatically detected as either a single legacy multiaddr or a list of multiaddrs (identified by underlayListPrefix), and is parsed accordingly.
func SelectBestAdvertisedAddress ¶ added in v2.7.0
func SerializeUnderlays ¶ added in v2.7.0
SerializeUnderlays serializes a slice of multiaddrs into a single byte slice. If the slice contains exactly one address, the standard, backward-compatible multiaddr format is used. For zero or more than one address, a custom list format prefixed with a magic byte is utilized.
Types ¶
type Address ¶
type Address struct {
Underlays []ma.Multiaddr
Overlay swarm.Address
Signature []byte
Nonce []byte
EthereumAddress []byte
}
Address represents the bzz address in swarm. It consists of a peers underlay (physical) address, overlay (topology) address and signature. Signature is used to verify the `Overlay/Underlay` pair, as it is based on `underlay|networkID`, signed with the public key of Overlay address
func NewAddress ¶
func ParseAddress ¶
func (*Address) MarshalJSON ¶
func (*Address) ShortString ¶
ShortString returns shortened versions of bzz address in a format: [Overlay, Underlay] It can be used for logging
func (*Address) UnmarshalJSON ¶
type TransportType ¶ added in v2.7.1
type TransportType int
TransportType represents the transport protocol of a multiaddress.
const ( // TransportUnknown indicates an unrecognized transport. TransportUnknown TransportType = iota // TransportTCP indicates plain TCP without WebSocket. TransportTCP // TransportWS indicates WebSocket without TLS. TransportWS // TransportWSS indicates WebSocket with TLS (secure). TransportWSS )
func ClassifyTransport ¶ added in v2.7.1
func ClassifyTransport(addr ma.Multiaddr) TransportType
ClassifyTransport returns the transport type of a multiaddress. It distinguishes between plain TCP, WebSocket (WS), and secure WebSocket (WSS).
func (TransportType) Priority ¶ added in v2.7.1
func (t TransportType) Priority() int
Priority returns the sorting priority for the transport type. Lower value = higher priority: TCP (0) > WS (1) > WSS (2) > Unknown (3)
func (TransportType) String ¶ added in v2.7.1
func (t TransportType) String() string
String returns a string representation of the transport type.
Source Files