aurora

Documentation

Overview

Package aurora exposes the data structure and operations necessary on the aurora.Address type which used in the handshake protocol, address-book and hive protocol.

Index

• Constants
• Variables
• type Address
  • func NewAddress(signer crypto.Signer, underlay ma.Multiaddr, overlay boson.Address, ...) (*Address, error)
  • func ParseAddress(underlay, overlay, signature []byte, networkID uint64) (*Address, error)
  • func (a *Address) Equal(b *Address) bool
  • func (a *Address) MarshalJSON() ([]byte, error)
  • func (a *Address) ShortString() string
  • func (a *Address) String() string
  • func (a *Address) UnmarshalJSON(b []byte) error
• type AddressInfo
  • func (i *AddressInfo) LightString() string
• type BitVectorApi
• type ChunkInfoOverlay
• type ChunkInfoSourceApi
• type ChunkSourceApi
• type FileInfo
• type Model
  • func NewModel() Model
  • func NewModelFromBytes(m []byte) (Model, error)
  • func (m Model) IsBootNode() bool
  • func (m Model) IsFull() bool
  • func (m Model) SetMode(md int) Model
  • func (m Model) String() string

Constants

const (
	FullNode = iota
	BootNode
)

Variables

var ErrInvalidAddress = errors.New("invalid address")

var ErrInvalidNodeMode = errors.New("invalid node mode")

Types

type Address

type Address struct {
	Underlay  ma.Multiaddr
	Overlay   boson.Address
	Signature []byte
}

Address represents the aurora address in boson. It consists of a peers underlay (physical) address, overlay (topology) address and signature. Signature is used to verify the `Overlay/Underlay` pair, as it is based on `underlay|networkID`, signed with the public key of Overlay address

func NewAddress

func NewAddress(signer crypto.Signer, underlay ma.Multiaddr, overlay boson.Address, networkID uint64) (*Address, error)

func ParseAddress

func ParseAddress(underlay, overlay, signature []byte, networkID uint64) (*Address, error)

func (*Address) Equal

func (a *Address) Equal(b *Address) bool

func (*Address) MarshalJSON

func (a *Address) MarshalJSON() ([]byte, error)

func (*Address) ShortString

func (a *Address) ShortString() string

ShortString returns shortened versions of aurora address in a format: [Overlay, Underlay] It can be used for logging

func (*Address) String

func (a *Address) String() string

func (*Address) UnmarshalJSON

func (a *Address) UnmarshalJSON(b []byte) error

type AddressInfo

type AddressInfo struct {
	Address  *Address
	NodeMode Model
}

AddressInfo contains the information received from the handshake.

func (*AddressInfo) LightString

func (i *AddressInfo) LightString() string

type BitVectorApi

type BitVectorApi struct {
	Len int    `json:"len"`
	B   []byte `json:"b"`
}

type ChunkInfoOverlay

type ChunkInfoOverlay struct {
	Overlay string       `json:"overlay"`
	Bit     BitVectorApi `json:"bit"`
}

type ChunkInfoSourceApi

type ChunkInfoSourceApi struct {
	PyramidSource string           `json:"pyramidSource"`
	ChunkSource   []ChunkSourceApi `json:"chunkSource"`
}

type ChunkSourceApi

type ChunkSourceApi struct {
	Overlay  string       `json:"overlay"`
	ChunkBit BitVectorApi `json:"chunkBit"`
}

type FileInfo

type FileInfo struct {
	TreeSize  int          `json:"treeSize"`
	FileSize  int          `json:"fileSize"`
	Bitvector BitVectorApi `json:"bitvector"`
	PinState  bool         `json:"pinState"`
}

type Model

type Model struct {
	Bv *bitvector.BitVector
}

func NewModel

func NewModel() Model

func NewModelFromBytes

func NewModelFromBytes(m []byte) (Model, error)

func (Model) IsBootNode

func (m Model) IsBootNode() bool

func (Model) IsFull

func (m Model) IsFull() bool

func (Model) SetMode

func (m Model) SetMode(md int) Model

func (Model) String

func (m Model) String() string