settings

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 4, 2024 License: MIT Imports: 27 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DNSProviderCloudflare = "cloudflare"
	DNSProviderDuckDNS    = "duckdns"
	DNSProviderNoIP       = "noip"
	DNSProviderRoute53    = "route53"
)

defines DNS providers

Variables

View Source 
var (
	// DefaultSettings are the default settings for the host
	DefaultSettings = Settings{
		AcceptingContracts:  false,
		NetAddress:          "",
		MaxContractDuration: 6 * blocksPerMonth,

		ContractPrice:     types.Siacoins(1).Div64(5),
		BaseRPCPrice:      types.Siacoins(1).Div64(1e6),
		SectorAccessPrice: types.Siacoins(1).Div64(1e6),

		CollateralMultiplier: 2.0,
		MaxCollateral:        types.Siacoins(1000),

		StoragePrice: types.Siacoins(150).Div64(1 << 40).Div64(blocksPerMonth),
		EgressPrice:  types.Siacoins(500).Div64(1 << 40),
		IngressPrice: types.Siacoins(10).Div64(1 << 40),

		PriceTableValidity: 30 * time.Minute,

		AccountExpiry:     30 * 24 * time.Hour,
		MaxAccountBalance: types.Siacoins(10),
		WindowSize:        144,

		MaxRegistryEntries: 100000,
	}
	// ErrNoSettings must be returned by the store if the host has no settings yet
	ErrNoSettings = errors.New("no settings found")
)

Functions

This section is empty.

Types

type Alerts 

type Alerts interface {
	Register(alerts.Alert)
}

Alerts registers global alerts.

type Announcement 

type Announcement struct {
	Index   types.ChainIndex `json:"index"`
	Address string           `json:"address"`
}

An Announcement contains the host's announced netaddress

type ChainManager 

type ChainManager interface {
	Tip() types.ChainIndex
	TipState() consensus.State
	BestIndex(height uint64) (types.ChainIndex, bool)
	RecommendedFee() types.Currency

	UnconfirmedParents(txn types.Transaction) []types.Transaction
	AddPoolTransactions([]types.Transaction) (known bool, err error)

	PoolTransactions() []types.Transaction
	V2PoolTransactions() []types.V2Transaction

	V2TransactionSet(types.ChainIndex, types.V2Transaction) (types.ChainIndex, []types.V2Transaction, error)
	AddV2PoolTransactions(types.ChainIndex, []types.V2Transaction) (known bool, err error)
}

ChainManager defines the interface required by the contract manager to interact with the consensus set.

type CloudflareSettings 

type CloudflareSettings struct {
	Token  string `json:"token"`
	ZoneID string `json:"zoneID"`
}

CloudflareSettings contains the settings for the Cloudflare DNS provider.

type ConfigManager 

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

A ConfigManager manages the host's current configuration

func NewConfigManager 

func NewConfigManager(hostKey types.PrivateKey, store Store, cm ChainManager, s Syncer, sm Storage, wm Wallet, opts ...Option) (*ConfigManager, error)

NewConfigManager initializes a new config manager

func (*ConfigManager) AcceptingContracts 

func (m *ConfigManager) AcceptingContracts() bool

AcceptingContracts returns true if the host is currently accepting contracts

func (*ConfigManager) Announce 

func (m *ConfigManager) Announce() error

Announce announces the host to the network

func (*ConfigManager) Close 

func (m *ConfigManager) Close() error

Close closes the config manager

func (*ConfigManager) LastAnnouncement 

func (m *ConfigManager) LastAnnouncement() (Announcement, error)

LastAnnouncement returns the last announcement that was made by the host

func (*ConfigManager) ProcessActions 

func (m *ConfigManager) ProcessActions(index types.ChainIndex) error

ProcessActions processes announcement actions based on the given chain index.

func (*ConfigManager) RHP2Settings 

func (m *ConfigManager) RHP2Settings() (proto2.HostSettings, error)

RHP2Settings returns the host's current RHP2 settings

func (*ConfigManager) RHP3PriceTable 

func (m *ConfigManager) RHP3PriceTable() (proto3.HostPriceTable, error)

RHP3PriceTable returns the host's current RHP3 price table

func (*ConfigManager) RHPBandwidthLimiters 

func (m *ConfigManager) RHPBandwidthLimiters() (ingress, egress *rate.Limiter)

RHPBandwidthLimiters returns the rate limiters for all RHP traffic

func (*ConfigManager) ScanHeight 

func (m *ConfigManager) ScanHeight() uint64

ScanHeight returns the last block height that was scanned for announcements

func (*ConfigManager) Settings 

func (m *ConfigManager) Settings() Settings

Settings returns the host's current settings.

func (*ConfigManager) UpdateChainState 

func (cm *ConfigManager) UpdateChainState(tx UpdateStateTx, reverted []chain.RevertUpdate, applied []chain.ApplyUpdate) error

UpdateChainState updates the host's announcement state based on the given chain updates.

func (*ConfigManager) UpdateDDNS 

func (m *ConfigManager) UpdateDDNS(force bool) error

UpdateDDNS triggers an update of the host's dynamic DNS records.

func (*ConfigManager) UpdateSettings 

func (m *ConfigManager) UpdateSettings(s Settings) error

UpdateSettings updates the host's settings.

type DNSSettings 

type DNSSettings struct {
	Provider string          `json:"provider"`
	IPv4     bool            `json:"ipv4"`
	IPv6     bool            `json:"ipv6"`
	Options  json.RawMessage `json:"options"`
}

DNSSettings contains the settings for the host's dynamic DNS.

type DuckDNSSettings 

type DuckDNSSettings struct {
	Token string `json:"token"`
}

DuckDNSSettings contains the settings for the DuckDNS DNS provider.

type NoIPSettings 

type NoIPSettings struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

NoIPSettings contains the settings for the No-IP DNS provider.

type Option 

type Option func(*ConfigManager)

An Option is a functional option that can be used to configure a config manager.

func WithAlertManager 

func WithAlertManager(am Alerts) Option

WithAlertManager sets the alerts manager for the settings manager.

func WithAnnounceInterval 

func WithAnnounceInterval(interval uint64) Option

WithAnnounceInterval sets the interval at which the host should re-announce itself.

func WithInitialSettings 

func WithInitialSettings(settings Settings) Option

WithInitialSettings sets the host's settings when the config manager is initialized. If this option is not provided, the default settings are used. If the database already contains settings, they will be used.

func WithLog 

func WithLog(log *zap.Logger) Option

WithLog sets the logger for the settings manager.

func WithRHP3Port 

func WithRHP3Port(port uint16) Option

WithRHP3Port sets the port that the host is listening for RHP3 connections on. This is part of the RHP2 settings.

func WithValidateNetAddress 

func WithValidateNetAddress(validate bool) Option

WithValidateNetAddress sets whether the settings manager should validate the announced net address.

type Route53Settings 

type Route53Settings struct {
	ID     string `json:"id"`
	Secret string `json:"secret"`
	ZoneID string `json:"zoneID"`
}

Route53Settings contains the settings for the Route53 DNS provider.

type Settings 

type Settings struct {
	// Host settings
	AcceptingContracts  bool   `json:"acceptingContracts"`
	NetAddress          string `json:"netAddress"`
	MaxContractDuration uint64 `json:"maxContractDuration"`
	WindowSize          uint64 `json:"windowSize"`

	// Pricing
	ContractPrice     types.Currency `json:"contractPrice"`
	BaseRPCPrice      types.Currency `json:"baseRPCPrice"`
	SectorAccessPrice types.Currency `json:"sectorAccessPrice"`

	CollateralMultiplier float64        `json:"collateralMultiplier"`
	MaxCollateral        types.Currency `json:"maxCollateral"`

	StoragePrice types.Currency `json:"storagePrice"`
	EgressPrice  types.Currency `json:"egressPrice"`
	IngressPrice types.Currency `json:"ingressPrice"`

	PriceTableValidity time.Duration `json:"priceTableValidity"`

	// Registry settings
	MaxRegistryEntries uint64 `json:"maxRegistryEntries"`

	// RHP3 settings
	AccountExpiry     time.Duration  `json:"accountExpiry"`
	MaxAccountBalance types.Currency `json:"maxAccountBalance"`

	// Bandwidth limiter settings
	IngressLimit uint64 `json:"ingressLimit"`
	EgressLimit  uint64 `json:"egressLimit"`

	// DNS settings
	DDNS DNSSettings `json:"ddns"`

	SectorCacheSize uint32 `json:"sectorCacheSize"`

	Revision uint64 `json:"revision"`
}

Settings contains configuration options for the host.

type Storage 

type Storage interface {
	Usage() (used, total uint64, _ error)
}

Storage provides information about the host's storage capacity

type Store 

type Store interface {
	// Settings returns the host's current settings. If the host has no
	// settings yet, ErrNoSettings must be returned.
	Settings() (Settings, error)
	// UpdateSettings updates the host's settings.
	UpdateSettings(s Settings) error

	LastAnnouncement() (Announcement, error)
	// LastV2AnnouncementHash returns the hash of the last v2 announcement.
	LastV2AnnouncementHash() (types.Hash256, types.ChainIndex, error)
}

A Store persists the host's settings

type Syncer 

type Syncer interface {
	BroadcastTransactionSet([]types.Transaction)
	BroadcastV2TransactionSet(types.ChainIndex, []types.V2Transaction)
}

A Syncer broadcasts transactions to its peers

type UpdateStateTx 

type UpdateStateTx interface {
	LastAnnouncement() (Announcement, error)
	RevertLastAnnouncement() error
	SetLastAnnouncement(Announcement) error

	// LastV2AnnouncementHash returns the hash of the last v2 announcement.
	LastV2AnnouncementHash() (types.Hash256, types.ChainIndex, error)
	// RevertLastV2Announcement reverts the last v2 announcement.
	RevertLastV2Announcement() error
	// SetLastV2Announcement sets the last v2 announcement.
	SetLastV2AnnouncementHash(types.Hash256, types.ChainIndex) error
}

An UpdateStateTx is a transaction that can update the host's announcement state.

type Wallet 

type Wallet interface {
	Address() types.Address
	ReleaseInputs(txns []types.Transaction, v2txns []types.V2Transaction)
	FundTransaction(txn *types.Transaction, amount types.Currency, useUnconfirmed bool) ([]types.Hash256, error)
	SignTransaction(txn *types.Transaction, toSign []types.Hash256, cf types.CoveredFields)

	FundV2Transaction(txn *types.V2Transaction, amount types.Currency, useUnconfirmed bool) (types.ChainIndex, []int, error)
	SignV2Inputs(txn *types.V2Transaction, toSign []int)
}

A Wallet manages Siacoins and funds transactions

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.