skynetportals

README

Skynet Portals

The Skynet Portals module manages a list of known Skynet portals and whether they are public or not.

Subsystems

The following subsystems help the Skynet Portals module execute its responsibilities:

• Skynet Portals Subsystem

Skynet Portals Subsystem

Key Files

• skynetportals.go

The Skynet Portals subsystem contains the structure of the Skynet Portals List and is used to create a new Skynet Portals List and return information about the Portals. Uses Persist package's Append-Only File subsystem to ensure ACID disk updates.

Exports

• Portals returns the list of known Skynet portals and whether they are public
• New creates and returns a new Skynet Portals List
• UpdatePortals updates the Portals List

Documentation

Index

• Variables
• type SkynetPortals
  • func New(persistDir string) (*SkynetPortals, error)
  • func (sp *SkynetPortals) Close() error
  • func (sp *SkynetPortals) Portals() []modules.SkynetPortal
  • func (sp *SkynetPortals) UpdatePortals(additions []modules.SkynetPortal, removals []modules.NetAddress) error

Variables

var (
	// ErrSkynetPortalsValidation is the error returned when validation of
	// changes to the Skynet portals list fails.
	ErrSkynetPortalsValidation = errors.New("could not validate additions and removals")
)

Types

type SkynetPortals

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

SkynetPortals manages a list of known Skynet portals by persisting the list to disk.

func New

func New(persistDir string) (*SkynetPortals, error)

New returns an initialized SkynetPortals.

func (*SkynetPortals) Close

func (sp *SkynetPortals) Close() error

Close closes and frees associated resources.

func (*SkynetPortals) Portals

func (sp *SkynetPortals) Portals() []modules.SkynetPortal

Portals returns the list of known Skynet portals.

func (*SkynetPortals) UpdatePortals

func (sp *SkynetPortals) UpdatePortals(additions []modules.SkynetPortal, removals []modules.NetAddress) error

UpdatePortals updates the list of known Skynet portals.