mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-25 12:57:18 +00:00
34 lines
1.7 KiB
Go
34 lines
1.7 KiB
Go
package encoder
|
|
|
|
import (
|
|
"io"
|
|
)
|
|
|
|
// Defines the different encoding formats
|
|
const (
|
|
SSZ = "ssz" // SSZ is SSZ only.
|
|
SSZSnappy = "ssz-snappy" // SSZSnappy is SSZ with snappy compression.
|
|
)
|
|
|
|
// NetworkEncoding represents an encoder compatible with Ethereum 2.0 p2p.
|
|
type NetworkEncoding interface {
|
|
// DecodeGossip to the provided gossip message. The interface must be a pointer to the decoding destination.
|
|
DecodeGossip([]byte, interface{}) error
|
|
// DecodeWithLength a bytes from a reader with a varint length prefix. The interface must be a pointer to the
|
|
// decoding destination.
|
|
DecodeWithLength(io.Reader, interface{}) error
|
|
// DecodeWithMaxLength a bytes from a reader with a varint length prefix. The interface must be a pointer to the
|
|
// decoding destination. The length of the message should not be more than the provided limit.
|
|
DecodeWithMaxLength(io.Reader, interface{}, uint64) error
|
|
// EncodeGossip an arbitrary gossip message to the provided writer. The interface must be a pointer object to encode.
|
|
EncodeGossip(io.Writer, interface{}) (int, error)
|
|
// EncodeWithLength an arbitrary message to the provided writer with a varint length prefix. The interface must be
|
|
// a pointer object to encode.
|
|
EncodeWithLength(io.Writer, interface{}) (int, error)
|
|
// EncodeWithMaxLength an arbitrary message to the provided writer with a varint length prefix. The interface must be
|
|
// a pointer object to encode. The encoded message should not be bigger than the provided limit.
|
|
EncodeWithMaxLength(io.Writer, interface{}, uint64) (int, error)
|
|
// ProtocolSuffix returns the last part of the protocol ID to indicate the encoding scheme.
|
|
ProtocolSuffix() string
|
|
}
|