renter

Documentation

Index

• Constants
• Variables
• func NewRSCode(nData, nParity int) (modules.ErasureCoder, error)
• type Renter
  • func New(g modules.Gateway, cs modules.ConsensusSet, wallet modules.Wallet, ...) (*Renter, error)
  • func (r *Renter) ActiveHosts() []modules.HostDBEntry
  • func (r *Renter) AllContracts() []modules.RenterContract
  • func (r *Renter) AllHosts() []modules.HostDBEntry
  • func (r *Renter) Close() error
  • func (r *Renter) Contracts() []modules.RenterContract
  • func (r *Renter) CurrentPeriod() types.BlockHeight
  • func (r *Renter) DeleteFile(nickname string) error
  • func (r *Renter) Download(path, destination string) error
  • func (r *Renter) DownloadQueue() []modules.DownloadInfo
  • func (r *Renter) FileList() []modules.FileInfo
  • func (r *Renter) Host(spk types.SiaPublicKey) (modules.HostDBEntry, bool)
  • func (r *Renter) LoadSharedFiles(filename string) ([]string, error)
  • func (r *Renter) LoadSharedFilesAscii(asciiSia string) ([]string, error)
  • func (r *Renter) PriceEstimation() modules.RenterPriceEstimation
  • func (r *Renter) RenameFile(currentName, newName string) error
  • func (r *Renter) ScoreBreakdown(e modules.HostDBEntry) modules.HostScoreBreakdown
  • func (r *Renter) SetSettings(s modules.RenterSettings) error
  • func (r *Renter) Settings() modules.RenterSettings
  • func (r *Renter) ShareFiles(nicknames []string, shareDest string) error
  • func (r *Renter) ShareFilesAscii(nicknames []string) (string, error)
  • func (r *Renter) Upload(up modules.FileUploadParams) error

Constants

const (
	PersistFilename = "renter.json"
	ShareExtension  = ".sia"
)

Variables

var (
	ErrEmptyFilename = errors.New("filename must be a nonempty string")
	ErrUnknownPath   = errors.New("no file known with that path")
	ErrPathOverload  = errors.New("a file already exists at that location")
)

var (
	ErrNoNicknames    = errors.New("at least one nickname must be supplied")
	ErrNonShareSuffix = errors.New("suffix of file must be " + ShareExtension)
	ErrBadFile        = errors.New("not a .sia file")
	ErrIncompatible   = errors.New("file is not compatible with current version")
)

Functions

func NewRSCode

func NewRSCode(nData, nParity int) (modules.ErasureCoder, error)

NewRSCode creates a new Reed-Solomon encoder/decoder using the supplied parameters.

Types

type Renter

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

A Renter is responsible for tracking all of the files that a user has uploaded to Sia, as well as the locations and health of these files.

func New

func New(g modules.Gateway, cs modules.ConsensusSet, wallet modules.Wallet, tpool modules.TransactionPool, persistDir string) (*Renter, error)

New returns an initialized renter.

func (*Renter) ActiveHosts

func (r *Renter) ActiveHosts() []modules.HostDBEntry

hostdb passthroughs

func (*Renter) AllContracts

func (r *Renter) AllContracts() []modules.RenterContract

func (*Renter) AllHosts

func (r *Renter) AllHosts() []modules.HostDBEntry

func (*Renter) Close

func (r *Renter) Close() error

Close closes the Renter and its dependencies

func (*Renter) Contracts

func (r *Renter) Contracts() []modules.RenterContract

contractor passthroughs

func (*Renter) CurrentPeriod

func (r *Renter) CurrentPeriod() types.BlockHeight

func (*Renter) DeleteFile

func (r *Renter) DeleteFile(nickname string) error

DeleteFile removes a file entry from the renter and deletes its data from the hosts it is stored on.

TODO: The data is not cleared from any contracts where the host is not immediately online.

func (*Renter) Download

func (r *Renter) Download(path, destination string) error

Download downloads a file, identified by its path, to the destination specified.

func (*Renter) DownloadQueue

func (r *Renter) DownloadQueue() []modules.DownloadInfo

DownloadQueue returns the list of downloads in the queue.

func (*Renter) FileList

func (r *Renter) FileList() []modules.FileInfo

FileList returns all of the files that the renter has.

func (*Renter) Host

func (r *Renter) Host(spk types.SiaPublicKey) (modules.HostDBEntry, bool)

func (*Renter) LoadSharedFiles

func (r *Renter) LoadSharedFiles(filename string) ([]string, error)

LoadSharedFiles loads a .sia file into the renter. It returns the nicknames of the loaded files.

func (*Renter) LoadSharedFilesAscii

func (r *Renter) LoadSharedFilesAscii(asciiSia string) ([]string, error)

LoadSharedFilesAscii loads an ASCII-encoded .sia file into the renter. It returns the nicknames of the loaded files.

func (*Renter) PriceEstimation

func (r *Renter) PriceEstimation() modules.RenterPriceEstimation

PriceEstimation estimates the cost in siacoins of performing various storage and data operations.

TODO: Make this function line up with the actual settings in the renter. Perhaps even make it so it uses the renter's actual contracts if it has any.

func (*Renter) RenameFile

func (r *Renter) RenameFile(currentName, newName string) error

RenameFile takes an existing file and changes the nickname. The original file must exist, and there must not be any file that already has the replacement nickname.

func (*Renter) ScoreBreakdown

func (r *Renter) ScoreBreakdown(e modules.HostDBEntry) modules.HostScoreBreakdown

func (*Renter) SetSettings

func (r *Renter) SetSettings(s modules.RenterSettings) error

SetSettings will update the settings for the renter.

func (*Renter) Settings

func (r *Renter) Settings() modules.RenterSettings

func (*Renter) ShareFiles

func (r *Renter) ShareFiles(nicknames []string, shareDest string) error

ShareFile saves the specified files to shareDest.

func (*Renter) ShareFilesAscii

func (r *Renter) ShareFilesAscii(nicknames []string) (string, error)

ShareFilesAscii returns the specified files in ASCII format.

func (*Renter) Upload

func (r *Renter) Upload(up modules.FileUploadParams) error

Upload instructs the renter to start tracking a file. The renter will automatically upload and repair tracked files using a background loop.