node

Documentation

Index

• Constants
• Variables
• func From(typ interface{}) interface{}
• type FullOption
  • func Lite(enable bool) FullOption
• type Option
  • func ApplyIf(check func(s *Settings) bool, opts ...Option) Option
  • func ConfigCommon(cfg *config.Common) Option
  • func ConfigFullNode(c interface{}) Option
  • func ConfigStorageMiner(c interface{}) Option
  • func Error(err error) Option
  • func FullAPI(out *api.FullNode, fopts ...FullOption) Option
  • func If(b bool, opts ...Option) Option
  • func MockHost(mn mocknet.Mocknet) Option
  • func Online() Option
  • func Options(opts ...Option) Option
  • func Override(typ, constructor interface{}) Option
  • func Repo(r repo.Repo) Option
  • func StorageMiner(out *api.StorageMiner) Option
  • func Test() Option
  • func Unset(typ interface{}) Option
• type Settings
• type StopFunc
  • func New(ctx context.Context, opts ...Option) (StopFunc, error)

Constants

const (
	// InitJournal at position 0 initializes the journal global var as soon as
	// the system starts, so that it's available for all other components.
	InitJournalKey = invoke(iota)

	PstoreAddSelfKeysKey
	StartListeningKey
	BootstrapKey

	// filecoin
	SetGenesisKey

	RunHelloKey
	RunChainExchangeKey
	RunChainGraphsync
	RunPeerMgrKey

	HandleIncomingBlocksKey
	HandleIncomingMessagesKey
	HandleMigrateClientFundsKey
	HandlePaymentChannelManagerKey

	// miner
	GetParamsKey
	HandleMigrateProviderFundsKey
	HandleDealsKey
	HandleRetrievalKey
	RunSectorServiceKey

	// daemon
	ExtractApiKey
	HeadMetricsKey
	SettlePaymentChannelsKey
	RunPeerTaggerKey
	SetupFallbackBlockstoreKey

	SetApiEndpointKey
)

Invokes are called in the order they are defined.

Variables

var (
	DefaultTransportsKey = special{0}  // Libp2p option
	DiscoveryHandlerKey  = special{2}  // Private type
	AddrsFactoryKey      = special{3}  // Libp2p option
	SmuxTransportKey     = special{4}  // Libp2p option
	RelayKey             = special{5}  // Libp2p option
	SecurityKey          = special{6}  // Libp2p option
	BaseRoutingKey       = special{7}  // fx groups + multiret
	NatPortMapKey        = special{8}  // Libp2p option
	ConnectionManagerKey = special{9}  // Libp2p option
	AutoNATSvcKey        = special{10} // Libp2p option
	BandwidthReporterKey = special{11} // Libp2p option
)

Functions

func From

func From(typ interface{}) interface{}

From(*T) -> func(t T) T {return t}

Types

type FullOption

type FullOption = Option

func Lite

func Lite(enable bool) FullOption

type Option

type Option func(*Settings) error

Option is a functional option which can be used with the New function to change how the node is constructed

Options are applied in sequence

func ApplyIf

func ApplyIf(check func(s *Settings) bool, opts ...Option) Option

func ConfigCommon

func ConfigCommon(cfg *config.Common) Option

Config sets up constructors based on the provided Config

func ConfigFullNode

func ConfigFullNode(c interface{}) Option

func ConfigStorageMiner

func ConfigStorageMiner(c interface{}) Option

func Error

func Error(err error) Option

Error is a special option which returns an error when applied

func FullAPI

func FullAPI(out *api.FullNode, fopts ...FullOption) Option

func If

func If(b bool, opts ...Option) Option

func MockHost

func MockHost(mn mocknet.Mocknet) Option

func Online

func Online() Option

Online sets up basic libp2p node

func Options

func Options(opts ...Option) Option

Options groups multiple options into one

func Override

func Override(typ, constructor interface{}) Option

Override option changes constructor for a given type

func Repo

func Repo(r repo.Repo) Option

func StorageMiner

func StorageMiner(out *api.StorageMiner) Option

func Test

func Test() Option

func Unset

func Unset(typ interface{}) Option

type Settings

type Settings struct {
	Online bool // Online option applied
	Config bool // Config option applied
	Lite   bool // Start node in "lite" mode
	// contains filtered or unexported fields
}

type StopFunc

type StopFunc func(context.Context) error

func New

func New(ctx context.Context, opts ...Option) (StopFunc, error)

New builds and starts new Filecoin node