waku

Documentation

Index

• func Execute(options Options)
• type DNSDiscoveryOptions
• type DiscV5Options
• type FilterOptions
• type LightpushOptions
• type MetricsOptions
• type Options
• type RPCServerOptions
• type RelayOptions
• type RendezvousOptions
• type RendezvousServerOptions
• type StoreOptions
  • func (s *StoreOptions) RetentionMaxDaysDuration() time.Duration
• type SwapOptions
• type WSOptions

Functions

func Execute

func Execute(options Options)

Execute starts a go-waku node with settings determined by the Options parameter

Types

type DNSDiscoveryOptions

type DNSDiscoveryOptions struct {
	Enable     bool
	URL        string
	Nameserver string
}

DNSDiscoveryOptions are settings used for enabling DNS-based discovery protocol that stores merkle trees in DNS records which contain connection information for nodes. It's very useful for bootstrapping a p2p network.

type DiscV5Options

type DiscV5Options struct {
	Enable     bool
	Nodes      cli.StringSlice
	Port       int
	AutoUpdate bool
}

type FilterOptions

type FilterOptions struct {
	Enable          bool
	DisableFullNode bool
	Nodes           cli.StringSlice
	Timeout         int
}

type LightpushOptions

type LightpushOptions struct {
	Enable bool
	Nodes  cli.StringSlice
}

LightpushOptions are settings used to enable the lightpush protocol. This is a lightweight protocol used to avoid having to run the relay protocol which is more resource intensive. With this protocol a message is pushed to a peer that supports both the lightpush protocol and relay protocol. That peer will broadcast the message and return a confirmation that the message was broadcasted

type MetricsOptions

type MetricsOptions struct {
	Enable  bool
	Address string
	Port    int
}

MetricsOptions are settings used to start a prometheus server for obtaining useful node metrics to monitor the health of behavior of the go-waku node.

type Options

type Options struct {
	Port             int
	Address          string
	Dns4DomainName   string
	NodeKey          string
	KeyFile          string
	GenerateKey      bool
	Overwrite        bool
	StaticNodes      cli.StringSlice
	KeepAlive        int
	UseDB            bool
	DBPath           string
	AdvertiseAddress string
	ShowAddresses    bool
	LogLevel         string

	Websocket        WSOptions
	Relay            RelayOptions
	Store            StoreOptions
	Swap             SwapOptions
	Filter           FilterOptions
	LightPush        LightpushOptions
	DiscV5           DiscV5Options
	Rendezvous       RendezvousOptions
	RendezvousServer RendezvousServerOptions
	DNSDiscovery     DNSDiscoveryOptions
	Metrics          MetricsOptions
	RPCServer        RPCServerOptions
}

Options contains all the available features and settings that can be configured via flags when executing go-waku as a service.

type RPCServerOptions

type RPCServerOptions struct {
	Enable  bool
	Port    int
	Address string
	Admin   bool
	Private bool
}

RPCServerOptions are settings used to start a json rpc server

type RelayOptions

type RelayOptions struct {
	Enable                 bool
	Topics                 cli.StringSlice
	PeerExchange           bool
	MinRelayPeersToPublish int
}

type RendezvousOptions

type RendezvousOptions struct {
	Enable bool
	Nodes  cli.StringSlice
}

type RendezvousServerOptions

type RendezvousServerOptions struct {
	Enable bool
	DBPath string
}

type StoreOptions

type StoreOptions struct {
	Enable               bool
	ShouldResume         bool
	RetentionMaxDays     int
	RetentionMaxMessages int
	Nodes                cli.StringSlice
}

StoreOptions are settings used for enabling the store protocol, used to retrieve message history from other nodes as well as acting as a store node and provide message history to nodes that ask for it.

func (*StoreOptions) RetentionMaxDaysDuration

func (s *StoreOptions) RetentionMaxDaysDuration() time.Duration

type SwapOptions

type SwapOptions struct {
	Mode                int
	PaymentThreshold    int
	DisconnectThreshold int
}

SwapOptions are settings used for configuring the swap protocol

type WSOptions

type WSOptions struct {
	Enable   bool
	Port     int
	Address  string
	Secure   bool
	KeyPath  string
	CertPath string
}