contractor

Sep 23, 2020

Changes in this version

+ const MaxCriticalRenewFailThreshold

+ var AlertCauseInsufficientAllowanceFunds = "Insufficient allowance funds remaining"

+ var AlertMSGAllowanceLowFunds = "At least one contract formation/renewal failed due to the allowance being low on funds"

+ var AlertMSGFailedContractRenewal = "Contractor is attempting to renew/refresh contracts but failed"

+ var AlertMSGWalletLockedDuringMaintenance = "At least one contract failed to form/renew due to the wallet being locked"

+ var ContractFeeFundingMulFactor = uint64(10)

+ var ErrAllowanceNoHosts = errors.New("hosts must be non-zero")

+ var ErrAllowanceZeroExpectedDownload = errors.New("expected download must be non-zero")

+ var ErrAllowanceZeroExpectedRedundancy = errors.New("expected redundancy must be non-zero")

+ var ErrAllowanceZeroExpectedStorage = errors.New("expected storage must be non-zero")

+ var ErrAllowanceZeroExpectedUpload = errors.New("expected upload must be non-zero")

+ var ErrAllowanceZeroFunds = errors.New("funds must be non-zero")

+ var ErrAllowanceZeroMaxPeriodChurn = errors.New("max period churn must be non-zero")

+ var ErrAllowanceZeroPeriod = errors.New("period must be non-zero")

+ var MaxInitialContractFundingDivFactor = uint64(3)

+ var MaxInitialContractFundingMulFactor = uint64(2)

+ var MinInitialContractFundingDivFactor = uint64(20)

+ var PersistFilename = "contractor.json"

type Contractor

+ func (c *Contractor) Alerts() (crit, err, warn []modules.Alert)

+ func (c *Contractor) ChurnStatus() modules.ContractorChurnStatus

+ func (c *Contractor) ContractPublicKey(pk types.SiaPublicKey) (crypto.PublicKey, bool)

+ func (c *Contractor) ContractStatus(fcID types.FileContractID) (modules.ContractWatchStatus, bool)

+ func (c *Contractor) MarkContractBad(id types.FileContractID) error

+ func (c *Contractor) ProvidePayment(stream io.ReadWriter, host types.SiaPublicKey, rpc types.Specifier, ...) error

+ func (c *Contractor) RefreshedContract(fcid types.FileContractID) bool

+ func (c *Contractor) Synced() <-chan struct{}

type Downloader

+ HostSettings func() modules.HostExternalSettings

type Editor

+ HostSettings func() modules.HostExternalSettings

type Session

+ DownloadIndex func(index uint64, offset, length uint32) ([]byte, error)

+ HostSettings func() modules.HostExternalSettings

+ Replace func(data []byte, sectorIndex uint64, trim bool) (crypto.Hash, error)

+ Settings func() (modules.HostExternalSettings, error)

type WalletBridge

+ func (ws *WalletBridge) RegisterTransaction(t types.Transaction, parents []types.Transaction) (transactionBuilder, error)

+ func (ws *WalletBridge) Unlocked() (bool, error)

Jun 23, 2019

Changes in this version

+ var MinContractFundRenewalThreshold = float64(0.06)

+ var MinContractFundUploadThreshold = float64(0.05)

type Contractor

+ func (c *Contractor) InitRecoveryScan() (err error)

+ func (c *Contractor) RecoverableContracts() []modules.RecoverableContract

+ func (c *Contractor) RecoveryScanStatus() (bool, types.BlockHeight)

+ func (c *Contractor) Session(pk types.SiaPublicKey, cancel <-chan struct{}) (_ Session, err error)

type Downloader

+ Download func(root crypto.Hash, offset, length uint32) ([]byte, error)

+ type Session interface

+ Address func() modules.NetAddress

+ Close func() error

+ ContractID func() types.FileContractID

+ Download func(root crypto.Hash, offset, length uint32) ([]byte, error)

+ EndHeight func() types.BlockHeight

+ Upload func(data []byte) (crypto.Hash, error)

type WalletBridge

+ func (ws *WalletBridge) PrimarySeed() (modules.Seed, uint64, error)

Sep 5, 2018

Changes in this version

type Contractor

+ func (c *Contractor) CancelContract(id types.FileContractID) error

+ func (c *Contractor) ContractByPublicKey(pk types.SiaPublicKey) (modules.RenterContract, bool)

+ func (c *Contractor) OldContracts() []modules.RenterContract

+ func (c *Contractor) ResolveIDToPubKey(id types.FileContractID) types.SiaPublicKey

Jun 12, 2018

Changes in this version

+ func NewPersist(dir string) *stdPersist

type Contractor

+ func NewCustomContractor(cs consensusSet, w wallet, tp transactionPool, hdb hostDB, ...) (*Contractor, error)

+ func (c *Contractor) RateLimits() (readBPW int64, writeBPS int64, packetSize uint64)

+ func (c *Contractor) SetRateLimits(readBPS int64, writeBPS int64, packetSize uint64)

+ type WalletBridge struct

+ W walletShim

+ func (ws *WalletBridge) NextAddress() (types.UnlockConditions, error)

+ func (ws *WalletBridge) StartTransaction() (transactionBuilder, error)

Dec 19, 2017

Changes in this version

type Contractor

+ func (c *Contractor) ContractUtility(id types.FileContractID) (modules.ContractUtility, bool)

+ func (c *Contractor) PeriodSpending() modules.ContractorSpending

Jul 25, 2017

Changes in this version

type Contractor

+ func (c *Contractor) ContractByID(id types.FileContractID) (modules.RenterContract, bool)

+ func (c *Contractor) GoodForRenew(id types.FileContractID) bool

Feb 28, 2017

Changes in this version

type Contractor

+ func (c *Contractor) Close() error

+ func (c *Contractor) ResolveID(id types.FileContractID) types.FileContractID

Jan 19, 2017

Changes in this version

type Contractor

+ func (c *Contractor) AllContracts() (cs []modules.RenterContract)

+ func (c *Contractor) CurrentPeriod() types.BlockHeight

+ func (c *Contractor) IsOffline(id types.FileContractID) bool

Oct 25, 2016

Changes in this version

+ var ErrAllowanceZeroWindow = errors.New("renew window must be non-zero")

+ var ErrInsufficientAllowance = errors.New("allowance is not large enough to cover fees of contract creation")

Jul 26, 2016

Changes in this version

type Contractor

+ func (c *Contractor) Contract(hostAddr modules.NetAddress) (modules.RenterContract, bool)

Jun 29, 2016

Changes in this version

+ type Contractor struct

+ func New(cs consensusSet, wallet walletShim, tpool transactionPool, hdb hostDB, ...) (*Contractor, error)

+ func (c *Contractor) Allowance() modules.Allowance

+ func (c *Contractor) Contracts() (cs []modules.RenterContract)

+ func (c *Contractor) Downloader(contract modules.RenterContract) (Downloader, error)

+ func (c *Contractor) Editor(contract modules.RenterContract) (Editor, error)

+ func (c *Contractor) FinancialMetrics() modules.RenterFinancialMetrics

+ func (c *Contractor) ProcessConsensusChange(cc modules.ConsensusChange)

+ func (c *Contractor) SetAllowance(a modules.Allowance) error

+ type Downloader interface

+ Close func() error

+ Sector func(root crypto.Hash) ([]byte, error)

+ type Editor interface

+ Address func() modules.NetAddress

+ Close func() error

+ ContractID func() types.FileContractID

+ Delete func(crypto.Hash) error

+ EndHeight func() types.BlockHeight

+ Modify func(oldRoot, newRoot crypto.Hash, offset uint64, newData []byte) error

+ Upload func(data []byte) (root crypto.Hash, err error)