utils

Documentation

Index

• Variables
• func AddressesToSubnets(resolvedAddresses []string) ([]string, error)
• func Auth(password string, unauthenticatedDownloads bool) func(http.Handler) http.Handler
• func DoRequest(req *http.Request, resp interface{}) (http.Header, int, error)
• func HumanReadableSize(b int) string
• func IsErr(err error, target error) bool
• func IsSynced(b types.Block) bool
• func IsVersion(str string) bool
• func ListenTCP(addr string, logger *zap.Logger) (net.Listener, error)
• func OpenBrowser(url string) error
• func ResolveHostIP(ctx context.Context, hostIP string) (ips []string, private bool, _ error)
• func VersionCmp(a, b string) int
• func WrapErr(ctx context.Context, fnName string, err *error)
• type AccountsKey
  • func (key *AccountsKey) DeriveAccountKey(hk types.PublicKey) types.PrivateKey
• type DataPoints
  • func NewDataPoints(halfLife time.Duration) *DataPoints
  • func (a *DataPoints) Average() float64
  • func (a *DataPoints) P90() float64
  • func (a *DataPoints) Recompute()
  • func (a *DataPoints) Track(p float64)
• type Float64Data
• type MasterKey
  • func (key *MasterKey) DeriveAccountsKey(workerID string) AccountsKey
  • func (key *MasterKey) DeriveContractKey(hostKey types.PublicKey) types.PrivateKey
• type TreeMux
  • func (t TreeMux) ServeHTTP(w http.ResponseWriter, req *http.Request)

Variables

var (
	ErrNoRouteToHost         = errors.New("no route to host")
	ErrNoSuchHost            = errors.New("no such host")
	ErrConnectionRefused     = errors.New("connection refused")
	ErrConnectionTimedOut    = errors.New("connection timed out")
	ErrConnectionResetByPeer = errors.New("connection reset by peer")
	ErrIOTimeout             = errors.New("i/o timeout")
)

Common i/o related errors

var (

	// ErrHostTooManyAddresses is returned by the worker API when a host has
	// more than two addresses of the same type.
	ErrHostTooManyAddresses = errors.New("host has more than two addresses, or two of the same type")
)

Functions

func AddressesToSubnets

func AddressesToSubnets(resolvedAddresses []string) ([]string, error)

func Auth

func Auth(password string, unauthenticatedDownloads bool) func(http.Handler) http.Handler

func DoRequest

func DoRequest(req *http.Request, resp interface{}) (http.Header, int, error)

func HumanReadableSize

func HumanReadableSize(b int) string

func IsErr

func IsErr(err error, target error) bool

IsErr can be used to compare an error to a target and also works when used on errors that haven't been wrapped since it will fall back to a string comparison. Useful to check errors returned over the network.

func IsSynced

func IsSynced(b types.Block) bool

func IsVersion

func IsVersion(str string) bool

IsVersion returns whether str is a valid release version with no -rc component.

func ListenTCP

func ListenTCP(addr string, logger *zap.Logger) (net.Listener, error)

func OpenBrowser

func OpenBrowser(url string) error

func ResolveHostIP

func ResolveHostIP(ctx context.Context, hostIP string) (ips []string, private bool, _ error)

func VersionCmp

func VersionCmp(a, b string) int

VersionCmp returns an int indicating the difference between a and b. It follows the convention of bytes.Compare and big.Cmp:

-1 if a <  b
 0 if a == b
+1 if a >  b

One important quirk is that "1.1.0" is considered newer than "1.1", despite being numerically equal.

func WrapErr

func WrapErr(ctx context.Context, fnName string, err *error)

WrapErr can be used to defer wrapping an error which is then decorated with the provided function name. If the context contains a cause error, it will also be included in the wrapping.

Types

type AccountsKey

type AccountsKey types.PrivateKey

func (*AccountsKey) DeriveAccountKey

func (key *AccountsKey) DeriveAccountKey(hk types.PublicKey) types.PrivateKey

DeriveAccountKey derives an account plus key for a given host and worker. Each worker has its own account for a given host. That makes concurrency around keeping track of an accounts balance and refilling it a lot easier in a multi-worker setup.

type DataPoints

type DataPoints struct {
	stats.Float64Data
	// contains filtered or unexported fields
}

func NewDataPoints

func NewDataPoints(halfLife time.Duration) *DataPoints

func (*DataPoints) Average

func (a *DataPoints) Average() float64

func (*DataPoints) P90

func (a *DataPoints) P90() float64

func (*DataPoints) Recompute

func (a *DataPoints) Recompute()

func (*DataPoints) Track

func (a *DataPoints) Track(p float64)

type Float64Data

type Float64Data = stats.Float64Data

type MasterKey

type MasterKey [32]byte

func (*MasterKey) DeriveAccountsKey

func (key *MasterKey) DeriveAccountsKey(workerID string) AccountsKey

DeriveAccountsKey derives an accounts key from a masterkey which is used to derive individual account keys from.

func (*MasterKey) DeriveContractKey

func (key *MasterKey) DeriveContractKey(hostKey types.PublicKey) types.PrivateKey

DeriveContractKey derives a contract key from a masterkey which is used to form, renew and revise contracts.

type TreeMux

type TreeMux struct {
	Handler http.Handler
	Sub     map[string]TreeMux
}

func (TreeMux) ServeHTTP

func (t TreeMux) ServeHTTP(w http.ResponseWriter, req *http.Request)