rest

Documentation

Index

• type Adder
• type AdminService
  • func NewAdminService(node *node.WakuNode, m *chi.Mux, log *zap.Logger) *AdminService
• type DebugService
  • func NewDebugService(node *node.WakuNode, m *chi.Mux) *DebugService
• type FilterService
  • func NewFilterService(node *node.WakuNode, m *chi.Mux, cacheCapacity int, log *zap.Logger) *FilterService
  • func (s *FilterService) Start(ctx context.Context)
  • func (r *FilterService) Stop()
• type HealthResponse
• type HealthService
  • func NewHealthService(node *node.WakuNode, m *chi.Mux) *HealthService
• type HistoryCursor
• type InfoArgs
• type InfoReply
• type LightpushService
  • func NewLightpushService(node *node.WakuNode, m *chi.Mux, log *zap.Logger) *LightpushService
• type RelayService
  • func NewRelayService(node *node.WakuNode, m *chi.Mux, cacheCapacity uint, log *zap.Logger) *RelayService
• type RestConfig
• type RestWakuMessage
  • func (r *RestWakuMessage) FromProto(input *pb.WakuMessage) error
  • func (r *RestWakuMessage) ToProto() (*pb.WakuMessage, error)
• type StoreResponse
• type StoreService
  • func NewStoreService(node *node.WakuNode, m *chi.Mux) *StoreService
• type StoreWakuMessage
• type VersionResponse
• type WakuPeer
• type WakuPeerInfo
• type WakuRest
  • func NewWakuRest(node *node.WakuNode, config RestConfig, log *zap.Logger) *WakuRest
  • func (r *WakuRest) Start(ctx context.Context, wg *sync.WaitGroup)
  • func (r *WakuRest) Stop(ctx context.Context) error

Types

type Adder

type Adder func(msg *protocol.Envelope)

type AdminService

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

func NewAdminService

func NewAdminService(node *node.WakuNode, m *chi.Mux, log *zap.Logger) *AdminService

type DebugService

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

func NewDebugService

func NewDebugService(node *node.WakuNode, m *chi.Mux) *DebugService

type FilterService

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

FilterService represents the REST service for Filter client

func NewFilterService

func NewFilterService(node *node.WakuNode, m *chi.Mux, cacheCapacity int, log *zap.Logger) *FilterService

NewFilterService returns an instance of FilterService

func (*FilterService) Start

func (s *FilterService) Start(ctx context.Context)

Start starts the RelayService

func (*FilterService) Stop

func (r *FilterService) Stop()

Stop stops the RelayService

type HealthResponse

type HealthResponse string

type HealthService

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

func NewHealthService

func NewHealthService(node *node.WakuNode, m *chi.Mux) *HealthService

type HistoryCursor

type HistoryCursor struct {
	PubsubTopic string `json:"pubsubTopic"`
	SenderTime  string `json:"senderTime"`
	StoreTime   string `json:"storeTime"`
	Digest      []byte `json:"digest"`
}

type InfoArgs

type InfoArgs struct {
}

type InfoReply

type InfoReply struct {
	ENRUri          string   `json:"enrUri,omitempty"`
	ListenAddresses []string `json:"listenAddresses,omitempty"`
}

type LightpushService

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

func NewLightpushService

func NewLightpushService(node *node.WakuNode, m *chi.Mux, log *zap.Logger) *LightpushService

type RelayService

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

RelayService represents the REST service for WakuRelay

func NewRelayService

func NewRelayService(node *node.WakuNode, m *chi.Mux, cacheCapacity uint, log *zap.Logger) *RelayService

NewRelayService returns an instance of RelayService

type RestConfig

type RestConfig struct {
	Address             string
	Port                uint
	EnablePProf         bool
	EnableAdmin         bool
	RelayCacheCapacity  uint
	FilterCacheCapacity uint
}

type RestWakuMessage

type RestWakuMessage struct {
	Payload      server.Base64URLByte `json:"payload"`
	ContentTopic string               `json:"contentTopic"`
	Version      *uint32              `json:"version,omitempty"`
	Timestamp    *int64               `json:"timestamp,omitempty"`
	Meta         []byte               `json:"meta,omitempty"`
}

func (*RestWakuMessage) FromProto

func (r *RestWakuMessage) FromProto(input *pb.WakuMessage) error

func (*RestWakuMessage) ToProto

func (r *RestWakuMessage) ToProto() (*pb.WakuMessage, error)

type StoreResponse

type StoreResponse struct {
	Messages     []StoreWakuMessage `json:"messages"`
	Cursor       *HistoryCursor     `json:"cursor,omitempty"`
	ErrorMessage string             `json:"error_message,omitempty"`
}

type StoreService

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

func NewStoreService

func NewStoreService(node *node.WakuNode, m *chi.Mux) *StoreService

type StoreWakuMessage

type StoreWakuMessage struct {
	Payload      []byte  `json:"payload"`
	ContentTopic string  `json:"contentTopic"`
	Version      *uint32 `json:"version,omitempty"`
	Timestamp    *int64  `json:"timestamp,omitempty"`
	Meta         []byte  `json:"meta,omitempty"`
}

type VersionResponse

type VersionResponse string

type WakuPeer

type WakuPeer struct {
	ID         string   `json:"id"`
	MultiAddrs []string `json:"multiaddrs"`
	Protocols  []string `json:"protocols"`
	Connected  bool     `json:"connected"`
}

type WakuPeerInfo

type WakuPeerInfo struct {
	MultiAddr string   `json:"multiaddr"`
	Shards    []int    `json:"shards"`
	Protocols []string `json:"protocols"`
}

type WakuRest

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

func NewWakuRest

func NewWakuRest(node *node.WakuNode, config RestConfig, log *zap.Logger) *WakuRest

func (*WakuRest) Start

func (r *WakuRest) Start(ctx context.Context, wg *sync.WaitGroup)

func (*WakuRest) Stop

func (r *WakuRest) Stop(ctx context.Context) error