shrexeds

Documentation

Index

• type Client
  • func NewClient(host host.Host, opts ...Option) (*Client, error)
  • func (c *Client) RequestEDS(ctx context.Context, dataHash share.DataHash, peers peer.IDSlice) (*rsmt2d.ExtendedDataSquare, error)
• type Option
  • func WithProtocolSuffix(protocolSuffix string) Option
• type Parameters
  • func DefaultParameters() *Parameters
  • func (p *Parameters) Validate() error
• type Server
  • func NewServer(host host.Host, store *eds.Store, opts ...Option) (*Server, error)
  • func (s *Server) Start(context.Context) error
  • func (s *Server) Stop(context.Context) error

Types

type Client

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

Client is responsible for requesting EDSs for blocksync over the ShrEx/EDS protocol.

func NewClient

func NewClient(host host.Host, opts ...Option) (*Client, error)

NewClient creates a new ShrEx/EDS client.

func (*Client) RequestEDS

func (c *Client) RequestEDS(
	ctx context.Context,
	dataHash share.DataHash,
	peers peer.IDSlice,
) (*rsmt2d.ExtendedDataSquare, error)

RequestEDS requests the full ODS from one of the given peers and returns the EDS.

The peers are requested in a round-robin manner with retries until one of them gives a valid response, blocking until the context is canceled or a valid response is given.

type Option

type Option func(*Parameters)

Option is the functional option that is applied to the shrex/eds protocol to configure its parameters.

func WithProtocolSuffix

func WithProtocolSuffix(protocolSuffix string) Option

WithProtocolSuffix is a functional option that configures the `protocolSuffix` parameter

type Parameters

type Parameters struct {
	// ReadDeadline sets the timeout for reading messages from the stream.
	ReadDeadline time.Duration

	// WriteDeadline sets the timeout for writing messages to the stream.
	WriteDeadline time.Duration

	// ReadCARDeadline defines the deadline for reading a CAR from disk.
	ReadCARDeadline time.Duration

	// BufferSize defines the size of the buffer used for writing an ODS over the stream.
	BufferSize uint64
	// contains filtered or unexported fields
}

Parameters is the set of parameters that must be configured for the shrex/eds protocol.

func DefaultParameters

func DefaultParameters() *Parameters

func (*Parameters) Validate

func (p *Parameters) Validate() error

type Server

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

Server is responsible for serving ODSs for blocksync over the ShrEx/EDS protocol.

func NewServer

func NewServer(host host.Host, store *eds.Store, opts ...Option) (*Server, error)

NewServer creates a new ShrEx/EDS server.

func (*Server) Start

func (s *Server) Start(context.Context) error

func (*Server) Stop

func (s *Server) Stop(context.Context) error