metadata

Documentation

Index

• Constants
• type WakuMetadata
  • func NewWakuMetadata(clusterID uint16, localnode *enode.LocalNode, log *zap.Logger) *WakuMetadata
  • func (wakuM *WakuMetadata) Connected(n network.Network, cc network.Conn)
  • func (wakuM *WakuMetadata) Disconnected(n network.Network, cc network.Conn)
  • func (wakuM *WakuMetadata) Listen(n network.Network, m multiaddr.Multiaddr)
  • func (wakuM *WakuMetadata) ListenClose(n network.Network, m multiaddr.Multiaddr)
  • func (wakuM *WakuMetadata) Request(ctx context.Context, peerID peer.ID) (*protocol.RelayShards, error)
  • func (wakuM *WakuMetadata) SetHost(h host.Host)
  • func (wakuM *WakuMetadata) Start(ctx context.Context) error
  • func (wakuM *WakuMetadata) Stop()

Constants

const MetadataID_v1 = libp2pProtocol.ID("/vac/waku/metadata/1.0.0")

MetadataID_v1 is the current Waku Metadata protocol identifier

Types

type WakuMetadata

type WakuMetadata struct {
	network.Notifiee
	// contains filtered or unexported fields
}

WakuMetadata is the implementation of the Waku Metadata protocol

func NewWakuMetadata

func NewWakuMetadata(clusterID uint16, localnode *enode.LocalNode, log *zap.Logger) *WakuMetadata

NewWakuMetadata returns a new instance of Waku Metadata struct Takes an optional peermanager if WakuLightPush is being created along with WakuNode. If using libp2p host, then pass peermanager as nil

func (*WakuMetadata) Connected

func (wakuM *WakuMetadata) Connected(n network.Network, cc network.Conn)

Connected is called when a connection is opened

func (*WakuMetadata) Disconnected

func (wakuM *WakuMetadata) Disconnected(n network.Network, cc network.Conn)

Disconnected is called when a connection closed

func (*WakuMetadata) Listen

func (wakuM *WakuMetadata) Listen(n network.Network, m multiaddr.Multiaddr)

Listen is called when network starts listening on an addr

func (*WakuMetadata) ListenClose

func (wakuM *WakuMetadata) ListenClose(n network.Network, m multiaddr.Multiaddr)

ListenClose is called when network stops listening on an address

func (*WakuMetadata) Request

func (wakuM *WakuMetadata) Request(ctx context.Context, peerID peer.ID) (*protocol.RelayShards, error)

func (*WakuMetadata) SetHost

func (wakuM *WakuMetadata) SetHost(h host.Host)

Sets the host to be able to mount or consume a protocol

func (*WakuMetadata) Start

func (wakuM *WakuMetadata) Start(ctx context.Context) error

Start inits the metadata protocol

func (*WakuMetadata) Stop

func (wakuM *WakuMetadata) Stop()

Stop unmounts the metadata protocol