aw

README

🌪 airwave

A flexible P2P networking library for upgradable distributed systems. The core mission of airwave is to provide a simple P2P interface that can support a wide variety of different algorithms, with a focus on backwards compatible. The P2P interface supports:

• Peer discovery
• Handshake
• Casting (send to one)
• Multicasting (send to many)
• Broadcasting (send to everyone)

Handshake

Airwave uses a 3 way sync handshake method to authorize peers in the network. The process is as follows:

The client sends a signed rsa public key on connect. The server validates the signature, generates a random challenge, and sends the signed random challenge encrypted with the client's public key; and the server's public key. The client validates the server's signature decrypts the challenge encrypts it with the server's publickey, signs it and sends it back.

Built with ❤ by Ren.

Documentation

Index

• type Builder
  • func New() *Builder
  • func (builder *Builder) Build() *Node
  • func (builder *Builder) WithAddr(addr wire.Address) *Builder
  • func (builder *Builder) WithContentResolver(contentResolver dht.ContentResolver) *Builder
  • func (builder *Builder) WithHost(host string) *Builder
  • func (builder *Builder) WithPort(port uint16) *Builder
  • func (builder *Builder) WithPrivKey(privKey *id.PrivKey) *Builder
• type ContentResolver
• type Node
  • func (node *Node) Addr() wire.Address
  • func (node *Node) Broadcast(ctx context.Context, subnet id.Hash, dataType uint8, data []byte)
  • func (node *Node) DHT() dht.DHT
  • func (node *Node) Gossiper() *gossip.Gossiper
  • func (node *Node) Identity() id.Signatory
  • func (node *Node) Peer() *peer.Peer
  • func (node *Node) Run(ctx context.Context)
  • func (node *Node) Send(ctx context.Context, signatory id.Signatory, dataType uint8, data []byte)
  • func (node *Node) Sync(ctx context.Context, subnet, hash id.Hash, dataType uint8) ([]byte, error)
  • func (node *Node) Transport() *transport.Transport
• type Options
  • func DefaultOptions() Options
  • func (opts Options) WithLogger(logger *zap.Logger) Options

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func New

func New() *Builder

func (*Builder) Build

func (builder *Builder) Build() *Node

func (*Builder) WithAddr

func (builder *Builder) WithAddr(addr wire.Address) *Builder

func (*Builder) WithContentResolver

func (builder *Builder) WithContentResolver(contentResolver dht.ContentResolver) *Builder

func (*Builder) WithHost

func (builder *Builder) WithHost(host string) *Builder

func (*Builder) WithPort

func (builder *Builder) WithPort(port uint16) *Builder

func (*Builder) WithPrivKey

func (builder *Builder) WithPrivKey(privKey *id.PrivKey) *Builder

type ContentResolver

type ContentResolver = dht.ContentResolver

type Node

type Node struct {
	// contains filtered or unexported fields
}

func (*Node) Addr

func (node *Node) Addr() wire.Address

func (*Node) Broadcast

func (node *Node) Broadcast(ctx context.Context, subnet id.Hash, dataType uint8, data []byte)

func (*Node) DHT

func (node *Node) DHT() dht.DHT

func (*Node) Gossiper

func (node *Node) Gossiper() *gossip.Gossiper

func (*Node) Identity

func (node *Node) Identity() id.Signatory

func (*Node) Peer

func (node *Node) Peer() *peer.Peer

func (*Node) Run

func (node *Node) Run(ctx context.Context)

func (*Node) Send

func (node *Node) Send(ctx context.Context, signatory id.Signatory, dataType uint8, data []byte)

func (*Node) Sync

func (node *Node) Sync(ctx context.Context, subnet, hash id.Hash, dataType uint8) ([]byte, error)

func (*Node) Transport

func (node *Node) Transport() *transport.Transport

type Options

type Options struct {
	Logger *zap.Logger
}

func DefaultOptions

func DefaultOptions() Options

func (Options) WithLogger

func (opts Options) WithLogger(logger *zap.Logger) Options