p2p

README

Enums

Go does not natively support enums. However, through the following design pattern, enums can be used.

package foo

type enum int

const (
  // Foo1 ...
  Foo1 enum = iota
  // Foo2 ...
  Foo2 enum
)

// Enum is the exported enum that can be required by outside packages
type Enum interface {
  Type() enum
  String() string
}

// Type returns the enum
func (f enum) Type() enum {
  return f
}

// NOTE: the String() method is made with the 'stringer' command

package bar

// RequiresFoo requires a Foo enum.
//
// In this way, only Foo1 or Foo2 can be passed to 'RequiresFoo'
func RequiresFoo(f foo.Enum) error {
  // do something with f...

  return nil
}

Stringer

Each enum in this package includes a String() method. Rather then implement these methods by hand for each enum, the code is auto generated using golang.org/x/tools/cmd/stringer. Run $ make check to see if you have stringer installed and $ make install/stringer if the previous check errors.

After following the above steps, run $ make to autogenerate the stringer methods.

Documentation

Index

• Constants
• Variables
• type P2P
  • func NewP2P(ctx context.Context, cancel context.CancelFunc, ch chan interface{}, ...) (*P2P, error)
  • func (p *P2P) Config() clienttypes.ConfigClient
  • func (p *P2P) GetNumPeers() (uint, error)
  • func (p *P2P) GetSyncer() (clienttypes.InterfaceSync, error)
  • func (p *P2P) IsStarted() bool
  • func (p *P2P) On(event p2ptypes.EventEnum, cb clienttypes.EventCallback)
  • func (p *P2P) Start() error
  • func (p *P2P) Stop() error

Constants

const (
	// Version is the semvar version of the build.
	Version string = "0.0.0"
)

Variables

var (
	// ErrNoPeersService ...
	ErrNoPeersService = errors.New("the p2p service has no peers service")
	// ErrUninitializedService ...
	ErrUninitializedService = errors.New("the p2p service has not been initialized")
	// ErrNoConfig ...
	ErrNoConfig = errors.New("a config is required")
	// ErrNoChainService ...
	ErrNoChainService = errors.New("a chain service is required")
	// ErrNoHost ...
	ErrNoHost = errors.New("the p2p service has no host")
	// ErrNoPublicKey ...
	ErrNoPublicKey = errors.New("the p2p service has no public key associated with it")
)

var DefaultAddress = fmt.Sprintf("/ip4/0.0.0.0/tcp/%v", DefaultPort)

DefaultAddress ...

var DefaultClientID = "golkadot/0.0.0"

DefaultClientID ...

var DefaultMaxPeers uint = 25

DefaultMaxPeers ...

var DefaultMaxQueuedBlocks = DefaultMaxRequestBlocks * 8

DefaultMaxQueuedBlocks ...

var DefaultMaxRequestBlocks uint = 64

DefaultMaxRequestBlocks ...

var DefaultMinIdleBlocks = 16

DefaultMinIdleBlocks ...

var DefaultPort uint = 30333

DefaultPort ...

var DefaultProtocolBase = "/substrate"

DefaultProtocolBase ... TODO: change...

var DefaultProtocolDot = fmt.Sprintf("%s%s/%d", DefaultProtocolBase, DefaultProtocolType, DefaultProtocolVersion)

DefaultProtocolDot ...

var DefaultProtocolPing = "/ipfs/ping/1.0.0"

DefaultProtocolPing ...

var DefaultProtocolType = "/sup"

DefaultProtocolType ...

var DefaultProtocolVersion = 1

DefaultProtocolVersion ...

var DefaultRole = "full"

DefaultRole ...

Types

type P2P

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

P2P implements the p2p interface

func NewP2P

func NewP2P(ctx context.Context, cancel context.CancelFunc, ch chan interface{}, cfg *clienttypes.ConfigClient, c clienttypes.InterfaceChains) (*P2P, error)

NewP2P builds a new p2p service

func (*P2P) Config

func (p *P2P) Config() clienttypes.ConfigClient

Config returns the config

func (*P2P) GetNumPeers

func (p *P2P) GetNumPeers() (uint, error)

GetNumPeers ...

func (*P2P) GetSyncer

func (p *P2P) GetSyncer() (clienttypes.InterfaceSync, error)

GetSyncer ...

func (*P2P) IsStarted

func (p *P2P) IsStarted() bool

IsStarted ...

func (*P2P) On

func (p *P2P) On(event p2ptypes.EventEnum, cb clienttypes.EventCallback)

On handles messages

func (*P2P) Start

func (p *P2P) Start() error

Start starts the p2p service

func (*P2P) Stop

func (p *P2P) Stop() error

Stop stops the p2p service