config

Documentation

Index

• func ConfigComment(t interface{}) ([]byte, error)
• func FromFile(path string, def interface{}) (interface{}, error)
• func FromReader(reader io.Reader, def interface{}) (interface{}, error)
• func StorageFromFile(path string, def *stores.StorageConfig) (*stores.StorageConfig, error)
• func StorageFromReader(reader io.Reader) (*stores.StorageConfig, error)
• func WriteStorageFile(path string, config stores.StorageConfig) error
• type API
• type Client
• type Common
• type DealmakingConfig
• type Duration
  • func (dur Duration) MarshalText() ([]byte, error)
  • func (dur *Duration) UnmarshalText(text []byte) error
• type FullNode
  • func DefaultFullNode() *FullNode
• type Libp2p
• type Metrics
• type Pubsub
• type StorageMiner
  • func DefaultStorageMiner() *StorageMiner

Functions

func ConfigComment

func ConfigComment(t interface{}) ([]byte, error)

func FromFile

func FromFile(path string, def interface{}) (interface{}, error)

FromFile loads config from a specified file overriding defaults specified in the def parameter. If file does not exist or is empty defaults are assumed.

func FromReader

func FromReader(reader io.Reader, def interface{}) (interface{}, error)

FromReader loads config from a reader instance.

func StorageFromFile

func StorageFromFile(path string, def *stores.StorageConfig) (*stores.StorageConfig, error)

func StorageFromReader

func StorageFromReader(reader io.Reader) (*stores.StorageConfig, error)

func WriteStorageFile

func WriteStorageFile(path string, config stores.StorageConfig) error

Types

type API

type API struct {
	ListenAddress       string
	RemoteListenAddress string
	Timeout             Duration
}

API contains configs for API endpoint

type Client

type Client struct {
	UseIpfs             bool
	IpfsMAddr           string
	IpfsUseForRetrieval bool
}

type Common

type Common struct {
	API    API
	Libp2p Libp2p
	Pubsub Pubsub
}

Common is common config between full node and miner

type DealmakingConfig

type DealmakingConfig struct {
	ConsiderOnlineStorageDeals    bool
	ConsiderOfflineStorageDeals   bool
	ConsiderOnlineRetrievalDeals  bool
	ConsiderOfflineRetrievalDeals bool
	PieceCidBlocklist             []cid.Cid
}

type Duration

type Duration time.Duration

Duration is a wrapper type for time.Duration for decoding and encoding from/to TOML

func (Duration) MarshalText

func (dur Duration) MarshalText() ([]byte, error)

func (*Duration) UnmarshalText

func (dur *Duration) UnmarshalText(text []byte) error

UnmarshalText implements interface for TOML decoding

type FullNode

type FullNode struct {
	Common
	Client  Client
	Metrics Metrics
}

FullNode is a full node config

func DefaultFullNode

func DefaultFullNode() *FullNode

DefaultFullNode returns the default config

type Libp2p

type Libp2p struct {
	ListenAddresses     []string
	AnnounceAddresses   []string
	NoAnnounceAddresses []string
	BootstrapPeers      []string
	ProtectedPeers      []string

	ConnMgrLow   uint
	ConnMgrHigh  uint
	ConnMgrGrace Duration
}

Libp2p contains configs for libp2p

type Metrics

type Metrics struct {
	Nickname   string
	HeadNotifs bool
}

type Pubsub

type Pubsub struct {
	Bootstrapper bool
	DirectPeers  []string
	RemoteTracer string
}

type StorageMiner

type StorageMiner struct {
	Common

	Dealmaking DealmakingConfig
	Storage    sectorstorage.SealerConfig
}

StorageMiner is a storage miner config

func DefaultStorageMiner

func DefaultStorageMiner() *StorageMiner