proto

Documentation

Overview

Package proto provides an implementation of the Nano network protocol.

Index

• Constants
• Variables
• func Name(id byte) string
• type BlockPacket
  • func (s BlockPacket) MarshalBinary() ([]byte, error)
  • func (s *BlockPacket) UnmarshalBinary(data []byte) error
• type BulkPullBlocksPacket
  • func (s *BulkPullBlocksPacket) ID() byte
  • func (s *BulkPullBlocksPacket) MarshalBinary() ([]byte, error)
  • func (s *BulkPullBlocksPacket) UnmarshalBinary(data []byte) error
• type BulkPullMode
• type BulkPullPacket
  • func (s *BulkPullPacket) ID() byte
  • func (s *BulkPullPacket) MarshalBinary() ([]byte, error)
  • func (s *BulkPullPacket) UnmarshalBinary(data []byte) error
• type ConfirmAckPacket
  • func (s *ConfirmAckPacket) ID() byte
  • func (s ConfirmAckPacket) MarshalBinary() ([]byte, error)
  • func (s *ConfirmAckPacket) UnmarshalBinary(data []byte) error
• type ConfirmReqPacket
  • func (s *ConfirmReqPacket) ID() byte
  • func (s ConfirmReqPacket) MarshalBinary() ([]byte, error)
  • func (s *ConfirmReqPacket) UnmarshalBinary(data []byte) error
• type FrontierReqPacket
  • func (s *FrontierReqPacket) ID() byte
  • func (s *FrontierReqPacket) MarshalBinary() ([]byte, error)
  • func (s *FrontierReqPacket) UnmarshalBinary(data []byte) error
• type HandshakePacket
  • func (s *HandshakePacket) ID() byte
  • func (s *HandshakePacket) MarshalBinary() ([]byte, error)
  • func (s *HandshakePacket) UnmarshalBinary(data []byte) error
• type Header
  • func (s *Header) BlockType() byte
  • func (s *Header) MarshalBinary() ([]byte, error)
  • func (s *Header) SetBlockType(b byte)
  • func (s *Header) UnmarshalBinary(data []byte) error
• type KeepAlivePacket
  • func (s *KeepAlivePacket) ID() byte
  • func (s *KeepAlivePacket) MarshalBinary() ([]byte, error)
  • func (s *KeepAlivePacket) UnmarshalBinary(data []byte) error
• type Network
  • func (n Network) MarshalText() ([]byte, error)
  • func (n Network) String() string
  • func (n *Network) UnmarshalText(text []byte) error
• type Packet
• type Proto
  • func New(net Network) *Proto
  • func (p *Proto) MarshalPacket(packet Packet) ([]byte, error)
  • func (p *Proto) NewHeader(packetType byte) *Header
  • func (p *Proto) NewKeepAlivePacket(peers []*net.UDPAddr) *KeepAlivePacket
  • func (p *Proto) UnmarshalPacket(data []byte) (Packet, error)
• type PublishPacket
  • func (s *PublishPacket) ID() byte
  • func (s PublishPacket) MarshalBinary() ([]byte, error)
  • func (s *PublishPacket) UnmarshalBinary(data []byte) error
• type Versions
• type VotePacket
  • func (s VotePacket) MarshalBinary() ([]byte, error)
  • func (s *VotePacket) UnmarshalBinary(data []byte) error

Constants

const (
	NetworkTest = 'Y'
	NetworkBeta = 'Z'
	NetworkLive = 'X'
)

const (
	HeaderSize = 8
)

Variables

var (
	ErrBadMagic  = errors.New("bad magic")
	ErrBadType   = errors.New("bad packet type")
	ErrBadLength = errors.New("bad packet length")
)

Functions

func Name

func Name(id byte) string

Types

type BlockPacket

type BlockPacket struct {
	Type  byte
	Block block.Block
}

func (BlockPacket) MarshalBinary

func (s BlockPacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*BlockPacket) UnmarshalBinary

func (s *BlockPacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type BulkPullBlocksPacket

type BulkPullBlocksPacket struct {
	Min   block.Hash
	Max   block.Hash
	Mode  BulkPullMode
	Count uint32
}

func (*BulkPullBlocksPacket) ID

func (s *BulkPullBlocksPacket) ID() byte

func (*BulkPullBlocksPacket) MarshalBinary

func (s *BulkPullBlocksPacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*BulkPullBlocksPacket) UnmarshalBinary

func (s *BulkPullBlocksPacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type BulkPullMode

type BulkPullMode byte

const (
	BulkPullModeList BulkPullMode = iota
	BulkPullModeChecksum
)

type BulkPullPacket

type BulkPullPacket struct {
	Address nano.Address
	Hash    block.Hash
}

func (*BulkPullPacket) ID

func (s *BulkPullPacket) ID() byte

func (*BulkPullPacket) MarshalBinary

func (s *BulkPullPacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*BulkPullPacket) UnmarshalBinary

func (s *BulkPullPacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type ConfirmAckPacket

type ConfirmAckPacket VotePacket

func (*ConfirmAckPacket) ID

func (s *ConfirmAckPacket) ID() byte

func (ConfirmAckPacket) MarshalBinary

func (s ConfirmAckPacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*ConfirmAckPacket) UnmarshalBinary

func (s *ConfirmAckPacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type ConfirmReqPacket

type ConfirmReqPacket BlockPacket

func (*ConfirmReqPacket) ID

func (s *ConfirmReqPacket) ID() byte

func (ConfirmReqPacket) MarshalBinary

func (s ConfirmReqPacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*ConfirmReqPacket) UnmarshalBinary

func (s *ConfirmReqPacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type FrontierReqPacket

type FrontierReqPacket struct {
	StartAddress nano.Address
	Age          uint32
	Count        uint32
}

func (*FrontierReqPacket) ID

func (s *FrontierReqPacket) ID() byte

func (*FrontierReqPacket) MarshalBinary

func (s *FrontierReqPacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*FrontierReqPacket) UnmarshalBinary

func (s *FrontierReqPacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type HandshakePacket

type HandshakePacket struct {
}

func (*HandshakePacket) ID

func (s *HandshakePacket) ID() byte

func (*HandshakePacket) MarshalBinary

func (s *HandshakePacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*HandshakePacket) UnmarshalBinary

func (s *HandshakePacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type Header

type Header struct {
	Magic        [2]byte
	VersionMax   byte
	VersionUsing byte
	VersionMin   byte
	MessageType  byte
	Extensions   uint16
}

func (*Header) BlockType

func (s *Header) BlockType() byte

func (*Header) MarshalBinary

func (s *Header) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*Header) SetBlockType

func (s *Header) SetBlockType(b byte)

func (*Header) UnmarshalBinary

func (s *Header) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type KeepAlivePacket

type KeepAlivePacket struct {
	Peers []*net.UDPAddr
}

func (*KeepAlivePacket) ID

func (s *KeepAlivePacket) ID() byte

func (*KeepAlivePacket) MarshalBinary

func (s *KeepAlivePacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*KeepAlivePacket) UnmarshalBinary

func (s *KeepAlivePacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type Network

type Network rune

func (Network) MarshalText

func (n Network) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (Network) String

func (n Network) String() string

String implements the fmt.Stringer interface.

func (*Network) UnmarshalText

func (n *Network) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

type Packet

type Packet interface {
	encoding.BinaryMarshaler
	encoding.BinaryUnmarshaler
	ID() byte
}

type Proto

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

func New

func New(net Network) *Proto

func (*Proto) MarshalPacket

func (p *Proto) MarshalPacket(packet Packet) ([]byte, error)

func (*Proto) NewHeader

func (p *Proto) NewHeader(packetType byte) *Header

func (*Proto) NewKeepAlivePacket

func (p *Proto) NewKeepAlivePacket(peers []*net.UDPAddr) *KeepAlivePacket

func (*Proto) UnmarshalPacket

func (p *Proto) UnmarshalPacket(data []byte) (Packet, error)

type PublishPacket

type PublishPacket BlockPacket

func (*PublishPacket) ID

func (s *PublishPacket) ID() byte

func (PublishPacket) MarshalBinary

func (s PublishPacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*PublishPacket) UnmarshalBinary

func (s *PublishPacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

type Versions

type Versions struct {
	Max   byte
	Using byte
	Min   byte
}

type VotePacket

type VotePacket struct {
	Type byte
	Vote block.Vote
}

func (VotePacket) MarshalBinary

func (s VotePacket) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*VotePacket) UnmarshalBinary

func (s *VotePacket) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.