mirror of
https://gitlab.com/pulsechaincom/erigon-pulse.git
synced 2024-12-28 14:47:16 +00:00
102 lines
2.7 KiB
Go
102 lines
2.7 KiB
Go
/*
|
|
Copyright 2022 Erigon-Lightclient contributors
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package communication
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/libp2p/go-libp2p-core/protocol"
|
|
pubsub "github.com/libp2p/go-libp2p-pubsub"
|
|
"github.com/libp2p/go-libp2p/core/network"
|
|
)
|
|
|
|
// packet simply needs to implement clone so that it can be instantiated within the generic
|
|
type Packet interface {
|
|
Clone() Packet
|
|
}
|
|
|
|
// context includes the original stream, the raw decompressed bytes, the codec the context was generated from, and the protocol ID
|
|
type StreamContext struct {
|
|
Packet Packet
|
|
Protocol protocol.ID
|
|
Codec StreamCodec
|
|
Stream network.Stream
|
|
|
|
Raw []byte
|
|
}
|
|
|
|
func (c *StreamContext) String() string {
|
|
return fmt.Sprintf("peer %s | packet %s | len %d", c.Stream.ID(), c.Protocol, c.Packet)
|
|
}
|
|
|
|
type GossipContext struct {
|
|
// the packet
|
|
Packet Packet
|
|
// the topic of the message
|
|
Topic *pubsub.Topic
|
|
// the actual message
|
|
Msg *pubsub.Message
|
|
// the codec used to decode the message
|
|
Codec GossipCodec
|
|
// the decompressed message in the native encoding of msg
|
|
Raw []byte
|
|
}
|
|
|
|
// PacketCodec describes a wire format.
|
|
type StreamCodec interface {
|
|
Close() error
|
|
CloseWriter() error
|
|
CloseReader() error
|
|
|
|
Write(payload []byte) (n int, err error)
|
|
WritePacket(pck Packet, prefix ...byte) (err error)
|
|
Decode(Packet) (ctx *StreamContext, err error)
|
|
|
|
Read(payload []byte) (n int, err error)
|
|
ReadByte() (b byte, err error)
|
|
}
|
|
|
|
// GossipCodec describes a wire format for pubsub messages
|
|
// it is linked to a single topiC
|
|
type GossipCodec interface {
|
|
WritePacket(ctx context.Context, pck Packet) (err error)
|
|
Decode(context.Context, Packet) (*GossipContext, error)
|
|
}
|
|
|
|
func (c *GossipContext) String() string {
|
|
return fmt.Sprintf("peer %s | topic %s | len %d", c.Msg.ReceivedFrom, c.Topic, c.Packet)
|
|
}
|
|
|
|
// the empty packet doesn't implement any serialization, so it means to skip.
|
|
type EmptyPacket struct{}
|
|
|
|
func (e *EmptyPacket) Clone() Packet {
|
|
return &EmptyPacket{}
|
|
}
|
|
|
|
// the error message skips decoding but does do the decompression.
|
|
type ErrorMessage struct {
|
|
Message []byte `json:"message"`
|
|
}
|
|
|
|
func (typ *ErrorMessage) Clone() Packet {
|
|
return &ErrorMessage{}
|
|
}
|
|
|
|
func (typ *ErrorMessage) UnmarshalSSZ(buf []byte) error {
|
|
typ.Message = buf
|
|
return nil
|
|
}
|