lotusidx

Documentation

Index

• type Config
• type Index
  • func New(ds datastore.Datastore, clientBuilder lotus.ClientBuilder, h P2PHost, ...) (*Index, error)
  • func (mi *Index) Close() error
  • func (mi *Index) Get() miner.IndexSnapshot
  • func (mi *Index) Listen() <-chan struct{}
  • func (mi *Index) Unregister(c chan struct{})
• type P2PHost

Types

type Config

type Config struct {
	RefreshOnStart     bool
	Disable            bool
	OnChainMaxParallel int
	OnChainFrequency   time.Duration
}

Config provides configuration parametrs to the miner index.

type Index

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

Index builds and provides information about FC miners.

func New

func New(ds datastore.Datastore, clientBuilder lotus.ClientBuilder, h P2PHost, lr iplocation.LocationResolver, conf Config) (*Index, error)

New returns a new MinerIndex. It loads from ds any previous state and starts immediately making the index up to date.

func (*Index) Close

func (mi *Index) Close() error

Close closes a MinerIndex.

func (*Index) Get

func (mi *Index) Get() miner.IndexSnapshot

Get returns a copy of the current index information.

func (*Index) Listen

func (mi *Index) Listen() <-chan struct{}

Listen returns a channel signaler to notify when new index information is available.

func (*Index) Unregister

func (mi *Index) Unregister(c chan struct{})

Unregister unregisters a channel signaler from the signaler hub.

type P2PHost

type P2PHost interface {
	Addrs(pid peer.ID) []multiaddr.Multiaddr
	Ping(ctx context.Context, pid peer.ID) bool
	GetAgentVersion(pid peer.ID) string
}

P2PHost provides a client to connect to a libp2p peer.