modules

Apr 16, 2021

Changes in this version

+ const AccountingDir

+ const LicenseMonetization

+ const RPCIReadRegistryEIDLen

+ var ErrPriceTableExpired = errors.New("Price table requested is expired")

+ var ErrPriceTableNotFound = errors.New("Price table not found")

+ var ErrUnknownLicense = errors.New("specified license is unknown")

+ var ErrZeroBase = errors.New("can't pay monetizers when the base is 0")

+ var ErrZeroConversionRate = fmt.Errorf("can't pay monetizers when the conversion rate for 0")

+ var SpecifierReadRegistryEID = InstructionSpecifier

+ func IsPriceTableInvalidErr(err error) bool

+ func PayMonetizers(w SiacoinSenderMulti, monetization *Monetization, ...) error

+ func RPCProvidePayment(stream io.Writer, accID AccountID, accSK crypto.SecretKey, ...) error

+ type Accounting interface

+ Accounting func() (AccountingInfo, error)

+ Close func() error

+ type AccountingInfo struct

+ Renter RenterAccounting

+ Wallet WalletAccounting

type ContractorSpending

+ FundAccountSpending types.Currency

+ MaintenanceSpending MaintenanceSpending

+ func (cs ContractorSpending) SpendingBreakdown() (totalSpent, unspentAllocated, unspentUnallocated types.Currency)

type FileInfo

+ RepairBytes uint64

+ StuckBytes uint64

type Host

+ StorageObligation func(obligationID types.FileContractID) (StorageObligation, error)

type Instruction

+ func NewReadRegistryEIDInstruction(sidOffset uint64, needPKAndTweakOffset bool) Instruction

+ type MaintenanceSpending struct

+ AccountBalanceCost types.Currency

+ FundAccountCost types.Currency

+ UpdatePriceTableCost types.Currency

+ func (x MaintenanceSpending) Add(y MaintenanceSpending) MaintenanceSpending

+ func (x MaintenanceSpending) Sum() types.Currency

+ type Monetization struct

+ License string

+ Monetizers []Monetizer

type PayByEphemeralAccountRequest

+ func NewPayByEphemeralAccountRequest(account AccountID, expiry types.BlockHeight, amount types.Currency, ...) PayByEphemeralAccountRequest

type ProgramBuilder

+ func (pb *ProgramBuilder) AddReadRegistryEIDInstruction(sid RegistryEntryID, needPKAndTweak bool) (types.Currency, error)

+ type RegistryEntryID crypto.Hash

+ func DeriveRegistryEntryID(pubKey types.SiaPublicKey, tweak crypto.Hash) RegistryEntryID

type RegistryValue

+ func (entry RegistryValue) HasMoreWork(target RegistryValue) bool

+ type RenterAccounting struct

+ UnspentUnallocated types.Currency

+ WithheldFunds types.Currency

type RenterContract

+ FundAccountSpending types.Currency

+ MaintenanceSpending MaintenanceSpending

type RenterSettings

+ CurrencyConversionRates map[string]types.Currency

+ MonetizationBase types.Currency

+ type SiacoinSenderMulti interface

+ SendSiacoinsMulti func(outputs []types.SiacoinOutput) ([]types.Transaction, error)

+ type SkyfileStreamer interface

+ Metadata func() SkyfileMetadata

+ type SpendingDetails struct

+ DownloadSpending types.Currency

+ FundAccountSpending types.Currency

+ MaintenanceSpending MaintenanceSpending

+ StorageSpending types.Currency

+ UploadSpending types.Currency

+ type WalletAccounting struct

+ ConfirmedSiacoinBalance types.Currency

+ ConfirmedSiafundBalance types.Currency

Feb 19, 2021

Changes in this version

+ const CurrencyUSD

+ const FCSignedIdentiferSize

+ const RenewDecodeMaxLen

+ const SubscriptionRequestStop

+ const SubscriptionResponseSubscriptionSuccess

+ const SubscriptionResponseUnsubscribeSuccess

+ var ErrCSIDoesNotMatchSeed = errors.New("ContractSignedIdentifier signature bytes not equal")

+ var ErrInvalidCurrency = errors.New("specified monetization currency is invalid")

+ var ErrMaxVirtualSectors = errors.New(...)

+ var ErrZeroMonetizer = errors.New("can't provide 0 monetization")

+ var ExtendedSuffix = "-extended"

+ var RepairThreshold = ...

+ func AddCommas(v uint64) string

+ func BandwidthUnits(bps uint64) string

+ func ComputeMonetizationPayout(amt, base types.Currency) types.Currency

+ func CurrencyUnits(c types.Currency) string

+ func GenerateContractKeyPair(renterSeed EphemeralRenterSeed, txn types.Transaction) (sk crypto.SecretKey, pk crypto.PublicKey)

+ func GenerateContractKeyPairWithOutputID(renterSeed EphemeralRenterSeed, inputParentID types.SiacoinOutputID) (sk crypto.SecretKey, pk crypto.PublicKey)

+ func MDMSubscribeCost(pt *RPCPriceTable, nFound, nEntries uint64) types.Currency

+ func MDMSubscriptionMemoryCost(pt *RPCPriceTable, nEntries uint64) types.Currency

+ func NeedsRepair(health float64) bool

+ func NewMultipartReader(reader io.Reader, subFiles SkyfileSubfiles) (*multipart.Reader, error)

+ func PrintAlerts(alerts []Alert, as AlertSeverity)

+ func RPCBeginSubscription(stream siamux.Stream, pp PaymentProvider, host types.SiaPublicKey, ...) error

+ func RPCExtendSubscription(stream siamux.Stream, pt *RPCPriceTable) error

+ func RPCFundSubscription(stream siamux.Stream, host types.SiaPublicKey, pp PaymentProvider, ...) error

+ func RPCReadMaxLen(r io.Reader, obj interface{}, maxLen uint64) error

+ func RPCStopSubscription(stream siamux.Stream) (err error)

+ func RPCUnsubscribeFromRVs(stream siamux.Stream, requests []RPCRegistrySubscriptionRequest) error

+ func V154MDMReadRegistryCost(pt *RPCPriceTable) (_ types.Currency)

+ func V154MDMUpdateRegistryCost(pt *RPCPriceTable) (_, _ types.Currency)

+ func ValidateMonetization(monetization []Monetizer) error

type BudgetLimit

+ func (bl *BudgetLimit) UpdateCosts(readCost, writeCost types.Currency)

+ type ContractParams struct

+ Allowance Allowance

+ EndHeight types.BlockHeight

+ Funding types.Currency

+ Host HostDBEntry

+ RefundAddress types.UnlockHash

+ RenterSeed EphemeralRenterSeed

+ StartHeight types.BlockHeight

+ type ContractSignedIdentifier [FCSignedIdentiferSize]byte

+ func PrefixedSignedIdentifier(renterSeed EphemeralRenterSeed, txn types.Transaction, ...) (ContractSignedIdentifier, crypto.Ciphertext)

+ func (csi ContractSignedIdentifier) IsValid(renterSeed EphemeralRenterSeed, txn types.Transaction, ...) (types.SiaPublicKey, bool, error)

type DirectoryInfo

+ AggregateRepairSize uint64

+ AggregateSkynetFiles uint64

+ AggregateSkynetSize uint64

+ AggregateStuckSize uint64

+ RepairSize uint64

+ SkynetFiles uint64

+ SkynetSize uint64

+ StuckSize uint64

+ type EphemeralRenterSeed RenterSeed

type File

+ Stat func() (os.FileInfo, error)

+ type HalfLifeDistribution struct

+ FifteenMinutes RequestTimeDistribution

+ FiveMinutes RequestTimeDistribution

+ LastUpdate time.Time

+ Lifetime RequestTimeDistribution

+ OneMinute RequestTimeDistribution

+ TwentyFourHours RequestTimeDistribution

+ func NewHalfLifeDistribution() HalfLifeDistribution

+ func (hld *HalfLifeDistribution) AddRequest(speed time.Duration, size uint64)

+ func (hld *HalfLifeDistribution) Update()

type KeyManager

+ MarkAddressUnused func(...types.UnlockConditions) error

+ type MemoryManagerStatus struct

+ Available uint64

+ Base uint64

+ PriorityAvailable uint64

+ PriorityBase uint64

+ PriorityRequested uint64

+ PriorityReserve uint64

+ Requested uint64

+ func (ms MemoryManagerStatus) Add(ms2 MemoryManagerStatus) MemoryManagerStatus

type MemoryStatus

+ Registry MemoryManagerStatus

+ System MemoryManagerStatus

+ UserDownload MemoryManagerStatus

+ UserUpload MemoryManagerStatus

+ type Monetizer struct

+ Address types.UnlockHash

+ Amount types.Currency

+ Currency string

type ProgramBuilder

+ func (pb *ProgramBuilder) V154AddReadRegistryInstruction(spk types.SiaPublicKey, tweak crypto.Hash) (types.Currency, error)

+ func (pb *ProgramBuilder) V154AddUpdateRegistryInstruction(spk types.SiaPublicKey, rv SignedRegistryValue) error

type RPCBudget

+ func (b *RPCBudget) Deposit(c types.Currency)

type RPCExecuteProgramResponse

+ FailureRefund types.Currency

type RPCPriceTable

+ SubscriptionNotificationCost types.Currency

+ type RPCRegistrySubscriptionNotificationEntryUpdate struct

+ Entry SignedRegistryValue

+ PubKey types.SiaPublicKey

+ func RPCSubscribeToRVs(stream siamux.Stream, requests []RPCRegistrySubscriptionRequest) ([]RPCRegistrySubscriptionNotificationEntryUpdate, error)

+ type RPCRegistrySubscriptionNotificationType struct

+ Type uint8

type Renter

+ BubbleMetadata func(siaPath SiaPath, force, recursive bool) error

+ RestoreSkyfile func(reader io.Reader) (Skylink, error)

+ type RenterSeed Seed

+ func DeriveRenterSeed(walletSeed Seed) RenterSeed

+ func (rs RenterSeed) EphemeralRenterSeed(windowStart types.BlockHeight) EphemeralRenterSeed

+ type RenterStats struct

+ ActiveContractData uint64

+ Alerts []Alert

+ AllowanceFunds types.Currency

+ AllowanceUnspentUnallocated types.Currency

+ HasPriorityRenterMemory bool

+ HasRenterMemory bool

+ Name string

+ PassiveContractData uint64

+ SkynetPerformance SkynetPerformanceStats

+ TotalContractRemainingFunds types.Currency

+ TotalContractSpentFees types.Currency

+ TotalContractSpentFunds types.Currency

+ TotalSiadirs uint64

+ TotalSiafiles uint64

+ TotalSize uint64

+ WalletFunds types.Currency

+ WastedContractData uint64

+ type RequestTimeDistribution struct

+ N1000ms float64

+ N10s float64

+ N120ms float64

+ N2000ms float64

+ N240ms float64

+ N5000ms float64

+ N500ms float64

+ N60ms float64

+ NErr float64

+ NLong float64

+ TotalSize float64

type SkyfileLayout

+ func (sl *SkyfileLayout) DecodeFanoutIntoChunks(fanoutBytes []byte) ([][]crypto.Hash, error)

type SkyfileMetadata

+ Monetization []Monetizer

type SkyfileMultipartUploadParameters

+ Monetization []Monetizer

type SkyfileSubfileMetadata

+ Monetization []Monetizer

+ func AddMultipartFileWithMonetization(w *multipart.Writer, filedata []byte, filekey, filename string, ...) (SkyfileSubfileMetadata, error)

type SkyfileUploadParameters

+ Monetization []Monetizer

type Skylink

+ func (sl Skylink) IsSkylinkV1() bool

+ type SkynetPerformanceStats struct

+ Download1MB HalfLifeDistribution

+ Download4MB HalfLifeDistribution

+ Download64KB HalfLifeDistribution

+ DownloadLarge HalfLifeDistribution

+ RegistryRead HalfLifeDistribution

+ RegistryWrite HalfLifeDistribution

+ TimeToFirstByte HalfLifeDistribution

+ Upload4MB HalfLifeDistribution

+ UploadLarge HalfLifeDistribution

+ func NewSkynetPerformanceStats() *SkynetPerformanceStats

+ func (sps *SkynetPerformanceStats) Copy() SkynetPerformanceStats

+ func (sps *SkynetPerformanceStats) Update()

+ type SkynetStats struct

+ NumFiles int

+ TotalSize uint64

+ type SubscriptionID crypto.Hash

+ func RegistrySubscriptionID(pubKey types.SiaPublicKey, tweak crypto.Hash) SubscriptionID

+ type Worker interface

+ RenewContract func(ctx context.Context, fcid types.FileContractID, params ContractParams, ...) (RenterContract, []types.Transaction, error)

+ type WorkerGenericJobsStatus struct

+ ConsecutiveFailures uint64

+ JobQueueSize uint64

+ OnCooldown bool

+ OnCooldownUntil time.Time

+ RecentErr string

+ RecentErrTime time.Time

+ type WorkerPool interface

+ Worker func(types.SiaPublicKey) (Worker, error)

+ type WorkerReadRegistryJobStatus struct

type WorkerStatus

+ ReadRegistryJobsStatus WorkerReadRegistryJobStatus

+ UpdateRegistryJobsStatus WorkerUpdateRegistryJobStatus

+ type WorkerUpdateRegistryJobStatus struct

Jan 11, 2021

Changes in this version

+ const InitialNumNotifications

+ const MetadataHeader

+ const MetadataVersion

+ const SkyfileLayoutSize

+ const SkyfileVersion

+ const SubscriptionEntrySize

+ const SubscriptionRequestExtend

+ const SubscriptionRequestInvalid

+ const SubscriptionRequestPrepay

+ const SubscriptionRequestSubscribe

+ const SubscriptionRequestUnsubscribe

+ const SubscriptionResponseInvalid

+ const SubscriptionResponseRegistryValue

+ var BaseSectorNonceDerivation = types.NewSpecifier("BaseSectorNonce")

+ var ErrEmptyFilename = errors.New("no filename provided")

+ var ErrIllegalFormName = errors.New(...)

+ var ErrInvalidDefaultPath = errors.New("invalid default path provided")

+ var ErrSkyfileMetadataUnavailable = errors.New("metadata unavailable")

+ var FanoutNonceDerivation = types.NewSpecifier("FanoutNonce")

+ var RPCRegistrySubscription = types.NewSpecifier("Subscription")

+ var RPCRenewContractRHP2 = types.NewSpecifier("RenewContract" + types.RuneToString(2))

+ var SubscriptionPeriod = ...

+ func BackupSkylink(skylink string, baseSector []byte, reader io.Reader, writer io.Writer) error

+ func BuildBaseSector(layoutBytes, fanoutBytes, metadataBytes, fileBytes []byte) ([]byte, uint64)

+ func DecodeFanout(sl SkyfileLayout, fanoutBytes []byte) (piecesPerChunk, chunkRootsSize, numChunks uint64, err error)

+ func DecryptBaseSector(baseSector []byte, sk skykey.Skykey) (skykey.Skykey, error)

+ func DeriveFanoutKey(sl *SkyfileLayout, fileSkykey skykey.Skykey) (crypto.CipherKey, error)

+ func IsEncryptedBaseSector(baseSector []byte) bool

+ func IsEncryptedLayout(sl SkyfileLayout) bool

+ func ParseSkyfileMetadata(baseSector []byte) (sl SkyfileLayout, fanoutBytes []byte, sm SkyfileMetadata, ...)

+ func RestoreSkylink(r io.Reader) (string, []byte, error)

+ func SkyfileMetadataBytes(sm SkyfileMetadata) ([]byte, error)

+ func SkylinkFromSysPath(path string) string

+ func SkylinkToSysPath(skylinkStr string) string

+ func SubscriptionNotificationsCost(pt *RPCPriceTable, numNotifications uint64) types.Currency

+ func ValidateSkyfileMetadata(metadata SkyfileMetadata) error

+ func VerifyRenewalTransactionSignatures(fcr types.FileContractRevision, fc types.FileContract, ...) error

type ConsensusSet

+ FoundationUnlockHashes func() (primary, failsafe types.UnlockHash)

+ type DirListFunc func(DirectoryInfo)

+ type FileListFunc func(FileInfo)

type RPCPriceTable

+ ContractPrice types.Currency

+ MaxCollateral types.Currency

+ MaxDuration types.BlockHeight

+ RenewContractCost types.Currency

+ SubscriptionBaseCost types.Currency

+ SubscriptionMemoryCost types.Currency

+ SubscriptionNotificationBaseCost types.Currency

+ WindowSize types.BlockHeight

+ type RPCRegistrySubscriptionNotification struct

+ Entry SignedRegistryValue

+ Type uint8

+ type RPCRegistrySubscriptionRequest struct

+ PubKey types.SiaPublicKey

+ Ratelimit uint32

+ Tweak crypto.Hash

+ type RPCRenewContractCollateralResponse struct

+ FinalRevSig crypto.Signature

+ NewInputs []types.SiacoinInput

+ NewOutputs []types.SiacoinOutput

+ NewParents []types.Transaction

+ type RPCRenewContractHostSignatures struct

+ ContractSignatures []types.TransactionSignature

+ NoOpRevisionSignature types.TransactionSignature

+ type RPCRenewContractRenterSignatures struct

+ RenterNoOpRevisionSig types.TransactionSignature

+ RenterTxnSigs []types.TransactionSignature

+ type RPCRenewContractRequest struct

+ FinalRevSig crypto.Signature

+ RenterPK types.SiaPublicKey

+ TSet []types.Transaction

type Renter

+ DownloadByRoot func(root crypto.Hash, offset, length uint64, timeout time.Duration) ([]byte, error)

+ type SkyfileBackupHeader struct

+ Skylink string

+ type SkyfileLayout struct

+ CipherType crypto.CipherType

+ FanoutDataPieces uint8

+ FanoutParityPieces uint8

+ FanoutSize uint64

+ Filesize uint64

+ KeyData [layoutKeyDataSize]byte

+ MetadataSize uint64

+ Version uint8

+ func (sl *SkyfileLayout) Decode(b []byte)

+ func (sl *SkyfileLayout) Encode() []byte

type SkyfileUploadParameters

+ DefaultPath string

+ DisableDefaultPath bool

+ Filename string

+ Mode os.FileMode

+ type SkyfileUploadReader interface

+ AddReadBuffer func(data []byte)

+ FanoutReader func() io.Reader

+ SkyfileMetadata func(ctx context.Context) (SkyfileMetadata, error)

+ func NewSkyfileMultipartReader(reader *multipart.Reader, fanoutReader *skyfileMultipartReader, ...) SkyfileUploadReader

+ func NewSkyfileMultipartReaderFromRequest(req *http.Request, sup SkyfileUploadParameters) (SkyfileUploadReader, error)

+ func NewSkyfileReader(reader io.Reader, sup SkyfileUploadParameters) SkyfileUploadReader

Nov 2, 2020

Changes in this version

+ const FileIDVersion

+ const HostRegistryFile

+ const HostWALFile

+ const KeySize

+ const MDMMaxBatchBufferSize

+ const MDMTimeReadRegistry

+ const MDMTimeUpdateRegistry

+ const RPCIReadRegistryLen

+ const RPCIUpdateRegistryLen

+ const RegistryDataSize

+ const RegistryEntrySize

+ const TweakSize

+ var ECPassthrough = ErasureCoderType

+ var ECReedSolomon = ErasureCoderType

+ var ECReedSolomonSubShards64 = ErasureCoderType

+ var ErrNotEnoughWorkersInWorkerPool = errors.New("not enough workers in worker pool")

+ var ErrSkylinkIncorrectSize = errors.New("skylink has incorrect size")

+ var Hostv151PersistMetadata = persist.Metadata

+ var RenterDefaultDataPieces = ...

+ var RenterDefaultParityPieces = ...

+ var SpecifierReadRegistry = InstructionSpecifier

+ var SpecifierUpdateRegistry = InstructionSpecifier

+ var VarFolder = NewGlobalSiaPath("/var")

+ func ExtractSegment(pieces [][]byte, segmentIndex int, segmentSize uint64) [][]byte

+ func MDMReadRegistryCollateral() types.Currency

+ func MDMReadRegistryCost(pt *RPCPriceTable) types.Currency

+ func MDMReadRegistryMemory() uint64

+ func MDMUpdateRegistryCollateral() types.Currency

+ func MDMUpdateRegistryCost(pt *RPCPriceTable) (_, _ types.Currency)

+ func MDMUpdateRegistryMemory() uint64

+ func RenewBaseCosts(lastRev types.FileContractRevision, host HostExternalSettings, ...) (basePrice, baseCollateral types.Currency)

+ func RoundRegistrySize(size uint64) uint64

type Allowance

+ func (a Allowance) PortalMode() bool

type ConsensusChange

+ AppliedDiffs []ConsensusChangeDiffs

+ RevertedDiffs []ConsensusChangeDiffs

+ func (cc *ConsensusChange) AppendDiffs(diffs ConsensusChangeDiffs)

+ type ConsensusChangeDiffs struct

+ DelayedSiacoinOutputDiffs []DelayedSiacoinOutputDiff

+ FileContractDiffs []FileContractDiff

+ SiacoinOutputDiffs []SiacoinOutputDiff

+ SiafundOutputDiffs []SiafundOutputDiff

+ SiafundPoolDiffs []SiafundPoolDiff

+ type DataSourceID crypto.Hash

type ErasureCoder

+ func NewPassthroughErasureCoder() ErasureCoder

+ func NewRSCode(nData, nParity int) (ErasureCoder, error)

+ func NewRSCodeDefault() ErasureCoder

+ func NewRSSubCode(nData, nParity int, segmentSize uint64) (ErasureCoder, error)

+ func NewRSSubCodeDefault() ErasureCoder

type Host

+ PriceTable func() RPCPriceTable

type HostInternalSettings

+ CustomRegistryPath string

+ RegistrySize uint64

type HostScoreBreakdown

+ AcceptContractAdjustment float64

type Instruction

+ func NewReadRegistryInstruction(pubKeyOff, pubKeyLen, tweakOff uint64) Instruction

+ func NewUpdateRegistryInstruction(...) Instruction

+ type PassthroughErasureCoder struct

+ func (pec *PassthroughErasureCoder) Encode(data []byte) ([][]byte, error)

+ func (pec *PassthroughErasureCoder) EncodeShards(pieces [][]byte) ([][]byte, error)

+ func (pec *PassthroughErasureCoder) Identifier() ErasureCoderIdentifier

+ func (pec *PassthroughErasureCoder) MinPieces() int

+ func (pec *PassthroughErasureCoder) NumPieces() int

+ func (pec *PassthroughErasureCoder) Reconstruct(pieces [][]byte) error

+ func (pec *PassthroughErasureCoder) Recover(pieces [][]byte, n uint64, w io.Writer) error

+ func (pec *PassthroughErasureCoder) SupportsPartialEncoding() (uint64, bool)

+ func (pec *PassthroughErasureCoder) Type() ErasureCoderType

type ProgramBuilder

+ func (pb *ProgramBuilder) AddReadRegistryInstruction(spk types.SiaPublicKey, tweak crypto.Hash) error

+ func (pb *ProgramBuilder) AddUpdateRegistryInstruction(spk types.SiaPublicKey, rv SignedRegistryValue) error

type RPCPriceTable

+ RegistryEntriesLeft uint64

+ RegistryEntriesTotal uint64

+ type RSCode struct

+ func (rs *RSCode) Encode(data []byte) ([][]byte, error)

+ func (rs *RSCode) EncodeShards(pieces [][]byte) ([][]byte, error)

+ func (rs *RSCode) Identifier() ErasureCoderIdentifier

+ func (rs *RSCode) MinPieces() int

+ func (rs *RSCode) NumPieces() int

+ func (rs *RSCode) Reconstruct(pieces [][]byte) error

+ func (rs *RSCode) Recover(pieces [][]byte, n uint64, w io.Writer) error

+ func (rs *RSCode) SupportsPartialEncoding() (uint64, bool)

+ func (rs *RSCode) Type() ErasureCoderType

+ type RSSubCode struct

+ func (rs *RSSubCode) Encode(data []byte) ([][]byte, error)

+ func (rs *RSSubCode) EncodeShards(pieces [][]byte) ([][]byte, error)

+ func (rs *RSSubCode) Identifier() ErasureCoderIdentifier

+ func (rs *RSSubCode) Reconstruct(pieces [][]byte) error

+ func (rs *RSSubCode) Recover(pieces [][]byte, n uint64, w io.Writer) error

+ func (rs *RSSubCode) SupportsPartialEncoding() (uint64, bool)

+ func (rs *RSSubCode) Type() ErasureCoderType

+ type RegistryValue struct

+ Data []byte

+ Revision uint64

+ Tweak crypto.Hash

+ func NewRegistryValue(tweak crypto.Hash, data []byte, rev uint64) RegistryValue

+ func (entry RegistryValue) Sign(sk crypto.SecretKey) SignedRegistryValue

type Renter

+ Blocklist func() ([]crypto.Hash, error)

+ DownloadSkylinkBaseSector func(Skylink, time.Duration) (Streamer, error)

+ ReadRegistry func(spk types.SiaPublicKey, tweak crypto.Hash, timeout time.Duration) (SignedRegistryValue, error)

+ UpdateRegistry func(spk types.SiaPublicKey, srv SignedRegistryValue, timeout time.Duration) error

+ UpdateSkynetBlocklist func(additions, removals []crypto.Hash) error

type RenterContract

+ func (rc *RenterContract) Size() uint64

+ type SignedRegistryValue struct

+ Signature crypto.Signature

+ func NewSignedRegistryValue(tweak crypto.Hash, data []byte, rev uint64, sig crypto.Signature) SignedRegistryValue

+ func (entry SignedRegistryValue) Verify(pk crypto.PublicKey) error

type SkyfileMetadata

+ Length uint64

type SkyfileSubfileMetadata

+ func AddMultipartFile(w *multipart.Writer, filedata []byte, filekey, filename string, ...) (SkyfileSubfileMetadata, error)

+ func (sm SkyfileSubfileMetadata) IsHTML() bool

type Skylink

+ func (sl *Skylink) Bytes() []byte

+ func (sl *Skylink) LoadBytes(data []byte) error

+ func (sl Skylink) DataSourceID() DataSourceID

type TransactionBuilder

+ Sweep func(output types.SiacoinOutput) (txn types.Transaction, parents []types.Transaction)

type WorkerAccountStatus

+ RecentSuccessTime time.Time

type WorkerStatus

+ DownloadCoolDownError string

+ DownloadCoolDownTime time.Duration

+ DownloadSnapshotJobQueueSize int

+ UploadSnapshotJobQueueSize int

Aug 5, 2020

Changes in this version

+ const MDMTimeRevision

+ const MDMTimeSwapSector

+ const RPCIRevisionLen

+ const RPCISwapSectorLen

+ const SkyfileDefaultPathParamName

+ const SkyfileDisableDefaultPathParamName

+ const StackSize

+ var CompatV1412DefaultEphemeralAccountExpiry = time.Minute * 60 * 24 * 7

+ var CompatV1412DefaultMaxEphemeralAccountBalance = types.SiacoinPrecision

+ var DefaultEphemeralAccountExpiry = time.Minute * 60 * 24 * 7

+ var DefaultMaxEphemeralAccountBalance = types.SiacoinPrecision

+ var ErrEmptyPath = errors.New("path must be a nonempty string")

+ var ErrInvalidPathString = errors.New("invalid path string")

+ var ErrInvalidSiaPath = errors.New("invalid SiaPath")

+ var RPCLatestRevision = types.NewSpecifier("LatestRevision")

+ var SkyfileFormatZip = SkyfileFormat("zip")

+ var SpecifierRevision = InstructionSpecifier

+ var SpecifierSwapSector = InstructionSpecifier

+ func EnsurePrefix(str, prefix string) string

+ func EnsureSuffix(str, suffix string) string

+ func MDMRevisionCollateral() types.Currency

+ func MDMRevisionCost(pt *RPCPriceTable) types.Currency

+ func MDMRevisionMemory() uint64

+ func MDMSwapSectorCollateral() types.Currency

+ func MDMSwapSectorCost(pt *RPCPriceTable) types.Currency

+ func MDMSwapSectorMemory() uint64

+ func ValidatePathString(path string, isRoot bool) error

type Gateway

+ AddToBlocklist func(addresses []string) error

+ Blocklist func() ([]string, error)

+ RemoveFromBlocklist func(addresses []string) error

+ SetBlocklist func(addresses []string) error

type HostExternalSettings

+ EphemeralAccountExpiry time.Duration

+ MaxEphemeralAccountBalance types.Currency

type Instruction

+ func NewRevisionInstruction(merkleRootOffset uint64) Instruction

+ func NewSwapSectorInstruction(sector1Offset, sector2Offset uint64, merkleProof bool) Instruction

+ type MDMInstructionRevisionResponse struct

+ RevisionTxn types.Transaction

+ type MemoryStatus struct

+ Available uint64

+ Base uint64

+ PriorityAvailable uint64

+ PriorityBase uint64

+ PriorityRequested uint64

+ PriorityReserve uint64

+ Requested uint64

type ProgramBuilder

+ func (pb *ProgramBuilder) AddRevisionInstruction()

+ func (pb *ProgramBuilder) AddSwapSectorInstruction(sector1Idx, sector2Idx uint64, merkleProof bool)

type RPCExecuteProgramResponse

+ StorageCost types.Currency

+ type RPCExecuteProgramRevisionSigningRequest struct

+ NewMissedProofValues []types.Currency

+ NewRevisionNumber uint64

+ NewValidProofValues []types.Currency

+ Signature []byte

+ type RPCExecuteProgramRevisionSigningResponse struct

+ Signature []byte

+ type RPCLatestRevisionRequest struct

+ FileContractID types.FileContractID

+ type RPCLatestRevisionResponse struct

+ Revision types.FileContractRevision

type RPCPriceTable

+ LatestRevisionCost types.Currency

+ RevisionBaseCost types.Currency

+ SwapSectorCost types.Currency

+ TxnFeeMaxRecommended types.Currency

+ TxnFeeMinRecommended types.Currency

type Renter

+ DeleteSkykeyByID func(skykey.SkykeyID) error

+ DeleteSkykeyByName func(string) error

+ MemoryStatus func() (MemoryStatus, error)

type SkyfileFormat

+ func (sf SkyfileFormat) Extension() string

+ func (sf SkyfileFormat) IsArchive() bool

type SkyfileMetadata

+ DefaultPath string

+ DisableDefaultPath bool

+ func (sm SkyfileMetadata) IsDirectory() bool

type SkyfileMultipartUploadParameters

+ DefaultPath string

+ DisableDefaultPath bool

+ type WorkerAccountStatus struct

+ AvailableBalance types.Currency

+ Funded bool

+ NegativeBalance types.Currency

+ RecentErr string

+ RecentErrTime time.Time

+ type WorkerHasSectorJobsStatus struct

+ AvgJobTime uint64

+ ConsecutiveFailures uint64

+ JobQueueSize uint64

+ RecentErr string

+ RecentErrTime time.Time

type WorkerPoolStatus

+ TotalMaintenanceCoolDown int

+ type WorkerPriceTableStatus struct

+ Active bool

+ ExpiryTime time.Time

+ RecentErr string

+ RecentErrTime time.Time

+ UpdateTime time.Time

+ type WorkerReadJobsStatus struct

+ AvgJobTime1m uint64

+ AvgJobTime4m uint64

+ AvgJobTime64k uint64

+ ConsecutiveFailures uint64

+ JobQueueSize uint64

+ RecentErr string

+ RecentErrTime time.Time

type WorkerStatus

+ AccountBalanceTarget types.Currency

+ AccountStatus WorkerAccountStatus

+ HasSectorJobsStatus WorkerHasSectorJobsStatus

+ MaintenanceCoolDownError string

+ MaintenanceCoolDownTime time.Duration

+ MaintenanceOnCooldown bool

+ PriceTableStatus WorkerPriceTableStatus

+ ReadJobsStatus WorkerReadJobsStatus

Jun 5, 2020

Changes in this version

type RPCPriceTable

+ StoreLengthCost types.Currency

Jun 3, 2020

Changes in this version

+ const MDMCancellationTokenLen

+ type MDMCancellationToken [MDMCancellationTokenLen]byte

type RPCPriceTable

+ Validity time.Duration

Jun 3, 2020

Changes in this version

+ const MDMTimeReadOffset

+ const RPCIReadOffsetLen

+ var RPCAccountBalance = types.NewSpecifier("AccountBalance")

+ var SpecifierReadOffset = InstructionSpecifier

+ func MDMBandwidthCost(pt RPCPriceTable, uploadBandwidth, downloadBandwidth uint64) types.Currency

+ type AccountBalanceRequest struct

+ Account AccountID

+ type AccountBalanceResponse struct

+ Balance types.Currency

type ConsensusChange

+ func (cc *ConsensusChange) UnmarshalSia(r io.Reader) error

+ func (cc ConsensusChange) MarshalSia(w io.Writer) error

type Dependencies

+ NebulousAddress func() types.UnlockHash

type FundAccountResponse

+ Balance types.Currency

type HostExternalSettings

+ func (hes HostExternalSettings) SiaMuxAddress() string

type Instruction

+ func NewAppendInstruction(dataOffset uint64, merkleProof bool) Instruction

+ func NewDropSectorsInstruction(numSectorsOffset uint64, merkleProof bool) Instruction

+ func NewReadOffsetInstruction(lengthOffset, offsetOffset uint64, merkleProof bool) Instruction

type ProductionDependencies

+ func (*ProductionDependencies) NebulousAddress() types.UnlockHash

type ProgramBuilder

+ func (pb *ProgramBuilder) AddAppendInstruction(data []byte, merkleProof bool)

+ func (pb *ProgramBuilder) AddDropSectorsInstruction(numSectors uint64, merkleProof bool)

+ func (pb *ProgramBuilder) AddReadOffsetInstruction(length, offset uint64, merkleProof bool)

+ type ProgramData []byte

type RPCPriceTable

+ AccountBalanceCost types.Currency

+ HostBlockHeight types.BlockHeight

+ type RPCTrackedPriceTableResponse struct

type Renter

+ Skykeys func() ([]skykey.Skykey, error)

May 11, 2020

Changes in this version

+ const DefaultMaxDuration

+ const MDMTimeDropSectorsBase

+ const MDMTimeDropSingleSector

+ const MDMTimeInitProgram

+ const MDMTimeInitSingleInstruction

+ var BackupFolder = NewGlobalSiaPath("/snapshots")

+ var DefaultBaseRPCPrice = types.SiacoinPrecision.Mul64(100).Div64(1e9)

+ var DefaultCollateral = types.SiacoinPrecision.Mul64(100).Div(BlockBytesPerMonthTerabyte)

+ var DefaultContractPrice = types.SiacoinPrecision.Div64(100).Div64(1e3).Mul64(EstimatedFileContractRevisionAndProofTransactionSetSize)

+ var DefaultDownloadBandwidthPrice = types.SiacoinPrecision.Mul64(25).Div(BytesPerTerabyte)

+ var DefaultMaxCollateral = types.SiacoinPrecision.Mul64(5e3)

+ var DefaultMaxDownloadBatchSize = 17 * (1 << 20)

+ var DefaultMaxReviseBatchSize = 17 * (1 << 20)

+ var DefaultSectorAccessPrice = types.SiacoinPrecision.Mul64(2).Div64(1e6)

+ var DefaultStoragePrice = types.SiacoinPrecision.Mul64(50).Div(BlockBytesPerMonthTerabyte)

+ var DefaultUploadBandwidthPrice = types.SiacoinPrecision.Mul64(1).Div(BytesPerTerabyte)

+ var DefaultWindowSize = ...

+ var ErrInsufficientBandwidthBudget = errors.New("insufficient budget for bandwidth")

+ var ErrMDMInsufficientCollateralBudget = errors.New("remaining collateral budget is insufficient")

+ var HomeFolder = NewGlobalSiaPath("/home")

+ var MDMProgramWriteResponseTime = ...

+ var RPCExecuteProgram = types.NewSpecifier("ExecuteProgram")

+ var RPCFundAccount = types.NewSpecifier("FundAccount")

+ var UserFolder = NewGlobalSiaPath("/home/user")

+ var ZeroAccountID = AccountID

+ func MDMAppendCollateral(pt *RPCPriceTable) types.Currency

+ func MDMDropSectorsCollateral() types.Currency

+ func MDMDropSectorsMemory() uint64

+ func MDMDropSectorsTime(numSectorsDropped uint64) uint64

+ func MDMHasSectorCollateral() types.Currency

+ func MDMInitMemory() uint64

+ func MDMReadCollateral() types.Currency

+ func NewBudgetLimit(budget *RPCBudget, readCost, writeCost types.Currency) mux.BandwidthLimit

+ func NewHostStream(mux *siamux.SiaMux, h Host) (siamux.Stream, error)

type AccountID

+ func NewAccountID() (id AccountID, sk crypto.SecretKey)

+ func (aid *AccountID) FromSPK(spk types.SiaPublicKey)

+ func (aid *AccountID) LoadString(s string) error

+ func (aid *AccountID) UnmarshalSia(r io.Reader) error

+ func (aid AccountID) IsZeroAccount() bool

+ func (aid AccountID) MarshalSia(w io.Writer) error

+ func (aid AccountID) PK() (pk crypto.PublicKey)

+ func (aid AccountID) SPK() (spk types.SiaPublicKey)

+ type AppFee struct

+ Address types.UnlockHash

+ Amount types.Currency

+ AppUID AppUID

+ FeeUID FeeUID

+ PaymentCompleted bool

+ PayoutHeight types.BlockHeight

+ Recurring bool

+ Timestamp int64

+ TransactionCreated bool

+ type AppFeeByTimestamp []AppFee

+ func (afbt AppFeeByTimestamp) Len() int

+ func (afbt AppFeeByTimestamp) Less(i, j int) bool

+ func (afbt AppFeeByTimestamp) Swap(i, j int)

+ type AppUID string

+ type BudgetLimit struct

+ func (bl *BudgetLimit) Downloaded() uint64

+ func (bl *BudgetLimit) RecordDownload(bytes uint64) error

+ func (bl *BudgetLimit) RecordUpload(bytes uint64) error

+ func (bl *BudgetLimit) Uploaded() uint64

type FeeManager

+ AddFee func(address types.UnlockHash, amount types.Currency, appUID AppUID, recurring bool) (FeeUID, error)

+ CancelFee func(feeUID FeeUID) error

+ PaidFees func() ([]AppFee, error)

+ PayoutHeight func() (types.BlockHeight, error)

+ PendingFees func() ([]AppFee, error)

+ type FeeUID string

type FileUploadParams

+ CipherKey crypto.CipherKey

+ type FundAccountRequest struct

+ Account AccountID

+ type FundAccountResponse struct

+ Receipt Receipt

+ Signature crypto.Signature

type HostExternalSettings

+ func DefaultHostExternalSettings() HostExternalSettings

+ func (hes HostExternalSettings) MaxBaseRPCPrice() types.Currency

+ func (hes HostExternalSettings) MaxSectorAccessPrice() types.Currency

type HostFinancialMetrics

+ AccountFunding types.Currency

+ PotentialAccountFunding types.Currency

type HostScoreBreakdown

+ BasePriceAdjustment float64

type Instruction

+ func NewHasSectorInstruction(merkleRootOffset uint64) Instruction

+ func NewReadSectorInstruction(lengthOffset, offsetOffset, merkleRootOffset uint64, merkleProof bool) Instruction

+ func RPCHasSectorInstruction(merkleRootOffset uint64) Instruction

type PayByContractRequest

+ RefundAccount AccountID

type PayByContractResponse

+ Balance types.Currency

type PayByEphemeralAccountResponse

+ Balance types.Currency

+ type PaymentProvider interface

+ ProvidePayment func(stream siamux.Stream, host types.SiaPublicKey, rpc types.Specifier, ...) error

+ type Program []Instruction

+ func (p Program) ReadOnly() bool

+ func (p Program) RequiresSnapshot() bool

+ type ProgramBuilder struct

+ func NewProgramBuilder(pt *RPCPriceTable) *ProgramBuilder

+ func (pb *ProgramBuilder) AddHasSectorInstruction(merkleRoot crypto.Hash)

+ func (pb *ProgramBuilder) AddReadSectorInstruction(length, offset uint64, merkleRoot crypto.Hash, merkleProof bool)

+ func (pb *ProgramBuilder) Cost(finalized bool) (cost, refund, collateral types.Currency)

+ func (pb *ProgramBuilder) Program() (Program, []byte)

+ type RPCBudget struct

+ func NewBudget(budget types.Currency) *RPCBudget

+ func (b *RPCBudget) Remaining() types.Currency

+ func (b *RPCBudget) Withdraw(c types.Currency) bool

+ type RPCExecuteProgramRequest struct

+ FileContractID types.FileContractID

+ Program Program

+ ProgramDataLength uint64

+ type RPCExecuteProgramResponse struct

+ AdditionalCollateral types.Currency

+ Error error

+ NewMerkleRoot crypto.Hash

+ NewSize uint64

+ OutputLength uint64

+ PotentialRefund types.Currency

+ Proof []crypto.Hash

+ TotalCost types.Currency

+ func (epr *RPCExecuteProgramResponse) UnmarshalSia(r io.Reader) error

+ func (epr RPCExecuteProgramResponse) MarshalSia(w io.Writer) error

type RPCPriceTable

+ CollateralCost types.Currency

+ DownloadBandwidthCost types.Currency

+ DropSectorsUnitCost types.Currency

+ FundAccountCost types.Currency

+ HasSectorBaseCost types.Currency

+ UID UniqueID

+ UploadBandwidthCost types.Currency

type Renter

+ AddSkykey func(skykey.Skykey) error

+ CreateSkykey func(string, crypto.CipherType) (skykey.Skykey, error)

+ Portals func() ([]SkynetPortal, error)

+ SkykeyByID func(skykey.SkykeyID) (skykey.Skykey, error)

+ SkykeyByName func(string) (skykey.Skykey, error)

+ SkykeyIDByName func(string) (skykey.SkykeyID, error)

+ UpdateSkynetPortals func(additions []SkynetPortal, removals []NetAddress) error

+ WorkerPoolStatus func() (WorkerPoolStatus, error)

type SkyfileUploadParameters

+ FileSpecificSkykey skykey.Skykey

+ SkykeyID skykey.SkykeyID

+ SkykeyName string

+ type SkynetPortal struct

+ Address NetAddress

+ Public bool

type StorageObligation

+ MissedProofOutputs []types.SiacoinOutput

+ PotentialAccountFunding types.Currency

+ RevisionNumber uint64

+ ValidProofOutputs []types.SiacoinOutput

+ type UniqueID types.Specifier

+ func (uid *UniqueID) LoadString(input string) error

+ func (uid *UniqueID) UnmarshalJSON(b []byte) error

+ func (uid UniqueID) MarshalJSON() ([]byte, error)

+ func (uid UniqueID) String() string

+ type WorkerPoolStatus struct

+ NumWorkers int

+ TotalDownloadCoolDown int

+ TotalUploadCoolDown int

+ Workers []WorkerStatus

+ type WorkerStatus struct

+ AvailableBalance types.Currency

+ BackupJobQueueSize int

+ BalanceTarget types.Currency

+ ContractID types.FileContractID

+ ContractUtility ContractUtility

+ DownloadOnCoolDown bool

+ DownloadQueueSize int

+ DownloadRootJobQueueSize int

+ DownloadTerminated bool

+ FundAccountJobQueueSize int

+ HostPubKey types.SiaPublicKey

+ UploadCoolDownError string

+ UploadCoolDownTime time.Duration

+ UploadOnCoolDown bool

+ UploadQueueSize int

+ UploadTerminated bool

Apr 2, 2020

Changes in this version

+ var ErrInvalidPaymentMethod = errors.New("invalid payment method")

+ var ErrUnknownPaymentMethod = errors.New("unknown payment method")

+ var MaxBaseRPCPriceVsBandwidth = uint64(40e3)

+ var MaxSectorAccessPriceVsBandwidth = uint64(400e3)

+ var PayByContract = types.NewSpecifier("PayByContract")

+ var PayByEphemeralAccount = types.NewSpecifier("PayByEphemAcc")

+ type AccountID string

type HostInternalSettings

+ func (his HostInternalSettings) MaxBaseRPCPrice() types.Currency

+ func (his HostInternalSettings) MaxSectorAccessPrice() types.Currency

+ type PayByContractRequest struct

+ ContractID types.FileContractID

+ NewMissedProofValues []types.Currency

+ NewRevisionNumber uint64

+ NewValidProofValues []types.Currency

+ Signature []byte

+ type PayByContractResponse struct

+ Signature crypto.Signature

+ type PayByEphemeralAccountRequest struct

+ Message WithdrawalMessage

+ Priority int64

+ Signature crypto.Signature

+ type PayByEphemeralAccountResponse struct

+ Amount types.Currency

+ type PaymentDetails interface

+ AccountID func() AccountID

+ AddedCollateral func() types.Currency

+ Amount func() types.Currency

+ type PaymentProcessor interface

+ ProcessPayment func(stream siamux.Stream) (PaymentDetails, error)

+ type PaymentRequest struct

+ Type types.Specifier

+ type Receipt struct

+ Account AccountID

+ Amount types.Currency

+ Host types.SiaPublicKey

+ Timestamp int64

type SkyfileUploadParameters

+ DryRun bool

Mar 24, 2020

Changes in this version

+ const FeeManagerDir

+ const HostSiaMuxSubscriberName

+ func RPCRead(stream siamux.Stream, obj interface{}) error

+ func RPCWrite(stream siamux.Stream, obj interface{}) error

+ func RPCWriteAll(stream siamux.Stream, objs ...interface{}) error

+ func RPCWriteError(stream siamux.Stream, err error) error

+ func SiaPKToMuxPK(spk types.SiaPublicKey) (mk mux.ED25519PublicKey)

+ type FeeManager interface

+ Close func() error

type HostExternalSettings

+ SiaMuxPort string

type RPCPriceTable

+ UUID types.Specifier

type Wallet

+ SendSiacoinsFeeIncluded func(amount types.Currency, dest types.UnlockHash) ([]types.Transaction, error)

Mar 17, 2020

Changes in this version

+ const MDMProgramInitTime

+ const MDMTimeAppend

+ const MDMTimeCommit

+ const MDMTimeHasSector

+ const MDMTimeReadSector

+ const MDMTimeWriteSector

+ const RPCIDropSectorsLen

+ const RPCIHasSectorLen

+ const SiaMuxDir

+ var ErrMDMInsufficientBudget = errors.New("remaining budget is insufficient")

+ var ErrSizeTooLarge = errors.New("file size exceeds sector size")

+ var ErrZeroSize = errors.New("file size of zero")

+ var RPCLoopRenewClearContract = types.NewSpecifier("LoopRenewClear")

+ var SectorSizeDev = uint64(1 << SectorSizeScalingDev)

+ var SectorSizeScalingDev = 18

+ var SectorSizeScalingStandard = 22

+ var SectorSizeScalingTesting = 12

+ var SectorSizeStandard = uint64(1 << SectorSizeScalingStandard)

+ var SectorSizeTesting = uint64(1 << SectorSizeScalingTesting)

+ var SkyfileFormatConcat = SkyfileFormat("concat")

+ var SkyfileFormatNotSpecified = SkyfileFormat("")

+ var SkyfileFormatTar = SkyfileFormat("tar")

+ var SkyfileFormatTarGz = SkyfileFormat("targz")

+ var SpecifierDropSectors = InstructionSpecifier

+ var SpecifierHasSector = InstructionSpecifier

+ func MDMAppendCost(pt RPCPriceTable) (types.Currency, types.Currency)

+ func MDMAppendMemory() uint64

+ func MDMCopyCost(pt RPCPriceTable, contractSize uint64) types.Currency

+ func MDMDropSectorsCost(pt RPCPriceTable, numSectorsDropped uint64) (types.Currency, types.Currency)

+ func MDMHasSectorCost(pt RPCPriceTable) (types.Currency, types.Currency)

+ func MDMHasSectorMemory() uint64

+ func MDMInitCost(pt RPCPriceTable, programLen uint64) types.Currency

+ func MDMMemoryCost(pt RPCPriceTable, usedMemory, time uint64) types.Currency

+ func MDMReadCost(pt RPCPriceTable, readLength uint64) (types.Currency, types.Currency)

+ func MDMReadMemory() uint64

+ func MDMSwapCost(pt RPCPriceTable, contractSize uint64) types.Currency

+ func MDMTruncateCost(pt RPCPriceTable, contractSize uint64) types.Currency

+ func MDMWriteCost(pt RPCPriceTable, writeLength uint64) (types.Currency, types.Currency)

+ type FilePlacement struct

+ FileID string

+ SectorIndex uint64

+ SectorOffset uint64

+ Size uint64

+ func PackFiles(files map[string]uint64) ([]FilePlacement, uint64, error)

type Host

+ HasSector func(crypto.Hash) bool

+ ReadPartialSector func(sectorRoot crypto.Hash, offset, length uint64) ([]byte, error)

+ type LoopRenewAndClearContractRequest struct

+ FinalMissedProofValues []types.Currency

+ FinalValidProofValues []types.Currency

+ RenterKey types.SiaPublicKey

+ Transactions []types.Transaction

+ type LoopRenewAndClearContractSignatures struct

+ ContractSignatures []types.TransactionSignature

+ FinalRevisionSignature []byte

+ RevisionSignature types.TransactionSignature

type RPCPriceTable

+ DropSectorsBaseCost types.Currency

+ DropSectorsLengthCost types.Currency

+ WriteStoreCost types.Currency

type Renter

+ Blacklist func() ([]crypto.Hash, error)

+ UpdateSkynetBlacklist func(additions, removals []Skylink) error

+ type SkyfileFormat string

type SkyfileMetadata

+ Subfiles SkyfileSubfiles

+ func (sm SkyfileMetadata) ContentType() string

+ func (sm SkyfileMetadata) ForPath(path string) (SkyfileMetadata, bool, uint64, uint64)

+ type SkyfileMultipartUploadParameters struct

+ BaseChunkRedundancy uint8

+ ContentType string

+ Filename string

+ Force bool

+ Reader io.Reader

+ Root bool

+ SiaPath SiaPath

+ type SkyfilePinParameters struct

+ BaseChunkRedundancy uint8

+ Force bool

+ Root bool

+ SiaPath SiaPath

+ type SkyfileSubfileMetadata struct

+ ContentType string

+ FileMode os.FileMode

+ Filename string

+ Len uint64

+ Offset uint64

+ func (sm SkyfileSubfileMetadata) IsDir() bool

+ func (sm SkyfileSubfileMetadata) ModTime() time.Time

+ func (sm SkyfileSubfileMetadata) Mode() os.FileMode

+ func (sm SkyfileSubfileMetadata) Name() string

+ func (sm SkyfileSubfileMetadata) Size() int64

+ func (sm SkyfileSubfileMetadata) Sys() interface{}

+ type SkyfileSubfiles map[string]SkyfileSubfileMetadata

type StorageManager

+ HasSector func(crypto.Hash) bool

+ ReadPartialSector func(sectorRoot crypto.Hash, offset, length uint64) ([]byte, error)

Feb 18, 2020

Changes in this version

+ const DefaultFilePerm

+ const HostSettingsFile

+ const RPCIAppendLen

+ const SkylinkMaxFetchSize

+ var ErrExpiredRPCPriceTable = errors.New(...)

+ var ErrInsufficientPaymentForRPC = errors.New(...)

+ var Hostv112PersistMetadata = persist.Metadata

+ var Hostv120PersistMetadata = persist.Metadata

+ var Hostv143PersistMetadata = persist.Metadata

+ var MDMComponentCompute = types.NewSpecifier("Compute")

+ var MDMComponentMemory = types.NewSpecifier("Memory")

+ var MDMOperationDiskAccess = types.NewSpecifier("DiskAccess")

+ var MDMOperationDiskRead = types.NewSpecifier("DiskRead")

+ var MDMOperationDiskWrite = types.NewSpecifier("DiskWrite")

+ var RPCUpdatePriceTable = types.NewSpecifier("UpdatePriceTable")

+ var SkynetFolder = NewGlobalSiaPath("/var/skynet")

+ var SpecifierAppend = InstructionSpecifier

+ func NewSiaMux(persistDir, address string) (*siamux.SiaMux, error)

type Allowance

+ PaymentContractInitialFunding types.Currency

type FileInfo

+ Skylinks []string

type Host

+ BandwidthCounters func() (uint64, uint64, time.Time, error)

type HostDB

+ CheckForIPViolations func([]types.SiaPublicKey) ([]types.SiaPublicKey, error)

+ Close func() error

+ EstimateHostScore func(HostDBEntry, Allowance) (HostScoreBreakdown, error)

+ Filter func() (FilterMode, map[string]types.SiaPublicKey, error)

+ Host func(pk types.SiaPublicKey) (HostDBEntry, bool, error)

+ IPViolationsCheck func() (bool, error)

+ IncrementFailedInteractions func(types.SiaPublicKey) error

+ IncrementSuccessfulInteractions func(types.SiaPublicKey) error

+ InitialScanComplete func() (bool, error)

+ RandomHostsWithAllowance func(int, []types.SiaPublicKey, []types.SiaPublicKey, Allowance) ([]HostDBEntry, error)

+ ScoreBreakdown func(HostDBEntry) (HostScoreBreakdown, error)

+ SetAllowance func(Allowance) error

+ SetFilterMode func(lm FilterMode, hosts []types.SiaPublicKey) error

+ SetIPViolationCheck func(enabled bool) error

+ UpdateContracts func([]RenterContract) error

+ type RPCPriceTable struct

+ Expiry int64

+ InitBaseCost types.Currency

+ MemoryTimeCost types.Currency

+ ReadBaseCost types.Currency

+ ReadLengthCost types.Currency

+ UpdatePriceTableCost types.Currency

+ WriteBaseCost types.Currency

+ WriteLengthCost types.Currency

+ type RPCUpdatePriceTableResponse struct

+ PriceTableJSON []byte

type Renter

+ CreateSkylinkFromSiafile func(SkyfileUploadParameters, SiaPath) (Skylink, error)

+ DownloadSkylink func(Skylink) (SkyfileMetadata, Streamer, error)

+ PinSkylink func(Skylink, SkyfileUploadParameters) error

+ UploadSkyfile func(SkyfileUploadParameters) (Skylink, error)

+ type SkyfileMetadata struct

+ Filename string

+ Mode os.FileMode

+ type SkyfileUploadParameters struct

+ BaseChunkRedundancy uint8

+ FileMetadata SkyfileMetadata

+ Force bool

+ Reader io.Reader

+ Root bool

+ SiaPath SiaPath

+ type Skylink struct

+ func NewSkylinkV1(merkleRoot crypto.Hash, offset, length uint64) (Skylink, error)

+ func (sl *Skylink) Bitfield() uint16

+ func (sl *Skylink) LoadString(s string) error

+ func (sl Skylink) MerkleRoot() crypto.Hash

+ func (sl Skylink) OffsetAndFetchSize() (offset uint64, fetchSize uint64, err error)

+ func (sl Skylink) String() string

+ func (sl Skylink) Version() uint16

Jan 22, 2020

Changes in this version

+ const AlertIDGatewayOffline

+ const AlertIDHostDiskTrouble

+ const AlertIDHostInsufficientCollateral

+ const AlertIDRenterAllowanceLowFunds

+ const AlertIDRenterContractRenewalError

+ const AlertIDWalletLockedDuringMaintenance

+ const CombinedChunksRoot

+ const DefaultDirPerm

+ const FileSystemRoot

+ const HomeFolderRoot

+ const MinimumSupportedRenterHostProtocolVersion

+ const RPCIReadSectorLen

+ const SeverityCritical

+ const SeverityError

+ const SeverityUnknown

+ const SeverityWarning

+ const SialinkMaxFetchSize

+ const StreamDownloadSize

+ const StreamUploadSize

+ const UserRoot

+ const V1420ContractNotRecognizedErrString

+ const V1420HostOutOfStorageErrString

+ const WithdrawalNonceSize

+ var ChunkMetadataExtension = ".ccmd"

+ var CombinedChunkExtension = ".cc"

+ var ConfigName = "siad.config"

+ var ErrWithdrawalExpired = errors.New("ephemeral account withdrawal message expired")

+ var ErrWithdrawalExtremeFuture = errors.New("ephemeral account withdrawal message expires too far into the future")

+ var ErrWithdrawalInvalidSignature = errors.New("ephemeral account withdrawal message signature is invalid")

+ var ErrWithdrawalsInactive = errors.New("ephemeral account withdrawals are inactive because the host is not synced")

+ var PartialsSiaFileExtension = ".csia"

+ var SpecifierReadSector = InstructionSpecifier

+ var UnfinishedChunkExtension = ".unfinished"

+ func FilesizeUnits(size uint64) string

+ func HealthPercentage(health float64) float64

+ func IsConsensusConflict(err error) bool

+ func IsContractNotRecognizedErr(err error) bool

+ func PeekErr(errChan <-chan error) (err error)

+ type Alert struct

+ Cause string

+ Module string

+ Msg string

+ Severity AlertSeverity

+ func (x Alert) Equals(y Alert) bool

+ func (x Alert) EqualsWithErrorCause(y Alert, causeErr string) bool

+ type AlertID string

+ func AlertIDSiafileLowRedundancy(uid string) AlertID

+ type AlertSeverity uint64

+ func (a *AlertSeverity) UnmarshalJSON(b []byte) error

+ func (a AlertSeverity) MarshalJSON() ([]byte, error)

+ func (a AlertSeverity) String() string

+ type Alerter interface

+ Alerts func() []Alert

type Allowance

+ MaxContractPrice types.Currency

+ MaxDownloadBandwidthPrice types.Currency

+ MaxPeriodChurn uint64

+ MaxRPCPrice types.Currency

+ MaxSectorAccessPrice types.Currency

+ MaxStoragePrice types.Currency

+ MaxUploadBandwidthPrice types.Currency

+ func (a Allowance) Active() bool

type BlockManager

+ SubmitBlock func(types.Block) error

+ type CombinedChunkID string

type ConsensusChangeID

+ func (ccID ConsensusChangeID) String() string

type ContractUtility

+ BadContract bool

+ type ContractWatchStatus struct

+ Archived bool

+ ContractFound bool

+ DoubleSpendHeight types.BlockHeight

+ FormationSweepHeight types.BlockHeight

+ LatestRevisionFound uint64

+ StorageProofFoundAtHeight types.BlockHeight

+ WindowEnd types.BlockHeight

+ WindowStart types.BlockHeight

+ type ContractorChurnStatus struct

+ AggregateCurrentPeriodChurn uint64

+ MaxPeriodChurn uint64

type DirectoryInfo

+ DirMode os.FileMode

+ DirSize uint64

+ UID uint64

+ func (d DirectoryInfo) IsDir() bool

+ func (d DirectoryInfo) ModTime() time.Time

+ func (d DirectoryInfo) Mode() os.FileMode

+ func (d DirectoryInfo) Name() string

+ func (d DirectoryInfo) Sys() interface{}

+ type DownloadID string

type EncryptionManager

+ ChangeKeyWithSeed func(seed Seed, newKey crypto.CipherKey) error

+ IsMasterKey func(masterKey crypto.CipherKey) (bool, error)

+ UnlockAsync func(masterKey crypto.CipherKey) <-chan error

type ErasureCoder

+ Identifier func() ErasureCoderIdentifier

+ type ErasureCoderIdentifier string

type FileInfo

+ FileMode os.FileMode

+ ModificationTime time.Time

+ UID uint64

+ func (f FileInfo) IsDir() bool

+ func (f FileInfo) Mode() os.FileMode

+ func (f FileInfo) Name() string

+ func (f FileInfo) Size() int64

+ func (f FileInfo) Sys() interface{}

type FileUploadParams

+ CipherType crypto.CipherType

+ DisablePartialChunk bool

type Gateway

+ AddToBlacklist func(addresses []string) error

+ BandwidthCounters func() (uint64, uint64, time.Time, error)

+ Blacklist func() ([]string, error)

+ RemoveFromBlacklist func(addresses []string) error

+ SetBlacklist func(addresses []string) error

+ type GenericAlerter struct

+ func NewAlerter(module string) *GenericAlerter

+ func (a *GenericAlerter) Alerts() []Alert

+ func (a *GenericAlerter) RegisterAlert(id AlertID, msg, cause string, severity AlertSeverity)

+ func (a *GenericAlerter) UnregisterAlert(id AlertID)

type Host

+ AddSector func(sectorRoot crypto.Hash, sectorData []byte) error

+ AddSectorBatch func(sectorRoots []crypto.Hash) error

+ AddStorageFolder func(path string, size uint64) error

+ Close func() error

+ DeleteSector func(sectorRoot crypto.Hash) error

+ ReadSector func(sectorRoot crypto.Hash) ([]byte, error)

+ RemoveSector func(sectorRoot crypto.Hash) error

+ RemoveSectorBatch func(sectorRoots []crypto.Hash) error

+ RemoveStorageFolder func(index uint16, force bool) error

+ ResetStorageFolderHealth func(index uint16) error

+ ResizeStorageFolder func(index uint16, newSize uint64, force bool) error

+ StorageFolders func() []StorageFolderMetadata

type HostInternalSettings

+ EphemeralAccountExpiry uint64

+ MaxEphemeralAccountBalance types.Currency

+ MaxEphemeralAccountRisk types.Currency

+ type Instruction struct

+ Args []byte

+ Specifier InstructionSpecifier

+ func RPCIReadSector(rootOff, offsetOff, lengthOff uint64, merkleProof bool) Instruction

+ type InstructionSpecifier types.Specifier

+ type MountInfo struct

+ MountOptions MountOptions

+ MountPoint string

+ SiaPath SiaPath

+ type MountOptions struct

+ AllowOther bool

+ ReadOnly bool

+ type PartialChunk struct

+ ChunkID CombinedChunkID

+ InPartialsFile bool

+ Length uint64

+ Offset uint64

type Renter

+ ContractStatus func(fcID types.FileContractID) (ContractWatchStatus, bool)

+ ContractorChurnStatus func() ContractorChurnStatus

+ DownloadByUID func(uid DownloadID) (DownloadInfo, bool)

+ Mount func(mountPoint string, sp SiaPath, opts MountOptions) error

+ MountInfo func() []MountInfo

+ PauseRepairsAndUploads func(duration time.Duration) error

+ ResumeRepairsAndUploads func() error

+ Unmount func(mountPoint string) error

type RenterDownloadParameters

+ DisableDiskFetch bool

type RenterSettings

+ IPViolationCheck bool

+ UploadsStatus UploadsStatus

type SiaPath

+ func CombinedSiaFilePath(ec ErasureCoder) SiaPath

+ func HomeSiaPath() SiaPath

+ func NewGlobalSiaPath(s string) SiaPath

+ func SnapshotsSiaPath() SiaPath

+ func UserSiaPath() SiaPath

+ func (sp SiaPath) IsEmpty() bool

+ func (sp SiaPath) SiaPartialsFileSysPath(dir string) string

type SiadConfig

+ WriteBPSDeprecated int64

+ type Sialink struct

+ func NewSialinkV1(merkleRoot crypto.Hash, offset, length uint64) (Sialink, error)

+ func (sl *Sialink) LoadString(s string) error

+ func (sl Sialink) MerkleRoot() crypto.Hash

+ func (sl Sialink) OffsetAndFetchSize() (offset uint64, fetchSize uint64, err error)

+ func (sl Sialink) String() string

+ func (sl Sialink) Version() uint16

type TransactionBuilder

+ Copy func() TransactionBuilder

+ MarkWalletInputs func() bool

+ ReplaceSiacoinOutput func(index uint64, output types.SiacoinOutput) error

type TransactionPool

+ Transactions func() []types.Transaction

+ type UploadsStatus struct

+ PauseEndTime time.Time

+ Paused bool

+ type WithdrawalMessage struct

+ Account string

+ Amount types.Currency

+ Expiry types.BlockHeight

+ Nonce [WithdrawalNonceSize]byte

+ func (wm *WithdrawalMessage) Validate(blockHeight, expiry types.BlockHeight, hash crypto.Hash, sig crypto.Signature) error

+ func (wm *WithdrawalMessage) ValidateExpiry(blockHeight, expiry types.BlockHeight) error

+ func (wm *WithdrawalMessage) ValidateSignature(hash crypto.Hash, sig crypto.Signature) error

Jul 3, 2019

Changes in this version

+ const BackupRoot

+ var ErrDownloadCancelled = errors.New("download was cancelled")

+ var ErrInsufficientStorageForSector = errors.New("not enough storage remaining to accept sector")

+ var GlobalRateLimits = ratelimit.NewRateLimit(0, 0, 0)

+ func IsOOSErr(err error) bool

type ContractUtility

+ LastOOSErr types.BlockHeight

type DirectoryInfo

+ AggregateHealth float64

+ AggregateLastHealthCheckTime time.Time

+ AggregateMaxHealth float64

+ AggregateMaxHealthPercentage float64

+ AggregateMinRedundancy float64

+ AggregateMostRecentModTime time.Time

+ AggregateNumSubDirs uint64

+ AggregateStuckHealth float64

+ MaxHealthPercentage float64

+ NumStuckChunks uint64

+ Size uint64

type ErasureCoder

+ Reconstruct func(pieces [][]byte) error

type FileUploadParams

+ Repair bool

type Gateway

+ ConnectManual func(NetAddress) error

+ DisconnectManual func(NetAddress) error

type HostScoreBreakdown

+ DurationAdjustment float64

type Renter

+ BackupsOnHost func(hostKey types.SiaPublicKey) ([]UploadedBackup, error)

+ DownloadBackup func(dst string, name string) error

+ Filter func() (FilterMode, map[string]types.SiaPublicKey, error)

+ RefreshedContract func(fcid types.FileContractID) bool

+ RenameDir func(oldPath, newPath SiaPath) error

+ SetFileStuck func(siaPath SiaPath, stuck bool) error

+ UploadBackup func(src string, name string) error

+ UploadStreamFromReader func(up FileUploadParams, reader io.Reader) error

+ UploadedBackups func() ([]UploadedBackup, []types.SiaPublicKey, error)

type SiaPath

+ func RandomSiaPath() (sp SiaPath)

+ func (sp *SiaPath) FromSysPath(siaFilePath, dir string) (err error)

+ func (sp *SiaPath) LoadSysPath(dir, path string) error

+ func (sp SiaPath) AddSuffix(suffix uint) SiaPath

+ func (sp SiaPath) Name() string

+ func (sp SiaPath) Rebase(oldBase, newBase SiaPath) (SiaPath, error)

+ func (sp SiaPath) Validate(isRoot bool) error

+ type SiadConfig struct

+ PacketSize uint64

+ ReadBPS int64

+ WriteBPS int64

+ func NewConfig(path string) (*SiadConfig, error)

+ func (cfg *SiadConfig) SetRatelimit(readBPS, writeBPS int64) error

+ type UploadedBackup struct

+ CreationDate types.Timestamp

+ Name string

+ Size uint64

+ UID [16]byte

+ UploadProgress float64

Apr 1, 2019

Changes in this version

+ const EstimatedFileContractRevisionAndProofTransactionSetSize

+ const RPCMinLen

+ const SiapathRoot

+ var BackupKeySpecifier = types.Specifier

+ var CipherChaCha20Poly1305 = types.Specifier

+ var CipherNoOverlap = types.Specifier

+ var ErrEmptySiaPath = errors.New("SiaPath must be a nonempty string")

+ var PrefixFileContractIdentifier = types.Specifier

+ var RPCChallengePrefix = types.Specifier

+ var RPCLoopEnter = types.Specifier

+ var RPCLoopExit = types.Specifier

+ var RPCLoopFormContract = types.Specifier

+ var RPCLoopLock = types.Specifier

+ var RPCLoopRead = types.Specifier

+ var RPCLoopReadStop = types.Specifier

+ var RPCLoopRenewContract = types.Specifier

+ var RPCLoopSectorRoots = types.Specifier

+ var RPCLoopSettings = types.Specifier

+ var RPCLoopUnlock = types.Specifier

+ var RPCLoopWrite = types.Specifier

+ var SiaDirExtension = ".siadir"

+ var SiaFileExtension = ".sia"

+ var WriteActionAppend = types.Specifier

+ var WriteActionSwap = types.Specifier

+ var WriteActionTrim = types.Specifier

+ var WriteActionUpdate = types.Specifier

+ func NewRenterSession(conn net.Conn, hostPublicKey types.SiaPublicKey) (*RenterHostSession, LoopChallengeRequest, error)

+ func ReadRPCID(r io.Reader, aead cipher.AEAD) (rpcID types.Specifier, err error)

+ func ReadRPCMessage(r io.Reader, aead cipher.AEAD, obj interface{}, maxLen uint64) error

+ func ReadRPCRequest(r io.Reader, aead cipher.AEAD, req interface{}, maxLen uint64) error

+ func ReadRPCResponse(r io.Reader, aead cipher.AEAD, resp interface{}, maxLen uint64) error

+ func WriteRPCMessage(w io.Writer, aead cipher.AEAD, obj interface{}) error

+ func WriteRPCRequest(w io.Writer, aead cipher.AEAD, rpcID types.Specifier, req interface{}) error

+ func WriteRPCResponse(w io.Writer, aead cipher.AEAD, resp interface{}, err error) error

type Allowance

+ ExpectedDownload uint64

+ ExpectedRedundancy float64

+ ExpectedStorage uint64

+ ExpectedUpload uint64

type Dependencies

+ Open func(string) (File, error)

+ type DirectoryInfo struct

+ AggregateNumFiles uint64

+ AggregateNumStuckChunks uint64

+ AggregateSize uint64

+ Health float64

+ LastHealthCheckTime time.Time

+ MaxHealth float64

+ MinRedundancy float64

+ MostRecentModTime time.Time

+ NumFiles uint64

+ NumSubDirs uint64

+ SiaPath string

+ StuckHealth float64

type ErasureCoder

+ SupportsPartialEncoding func() bool

+ Type func() ErasureCoderType

+ type ErasureCoderType [4]byte

type File

+ Seek func(int64, int) (int64, error)

type FileInfo

+ AccessTime time.Time

+ ChangeTime time.Time

+ CipherType string

+ CreateTime time.Time

+ Health float64

+ MaxHealth float64

+ MaxHealthPercent float64

+ ModTime time.Time

+ NumStuckChunks uint64

+ Stuck bool

+ StuckHealth float64

type FileUploadParams

+ Force bool

+ type FilterMode int

+ const HostDBActivateBlacklist

+ const HostDBActiveWhitelist

+ const HostDBDisableFilter

+ const HostDBFilterError

+ func (fm *FilterMode) FromString(s string) error

+ func (fm FilterMode) String() string

type Gateway

+ RateLimits func() (int64, int64)

+ SetRateLimits func(downloadSpeed, uploadSpeed int64) error

type Host

+ PruneStaleStorageObligations func() error

type HostDBEntry

+ Filtered bool

type HostExternalSettings

+ BaseRPCPrice types.Currency

+ SectorAccessPrice types.Currency

type HostInternalSettings

+ MinBaseRPCPrice types.Currency

+ MinSectorAccessPrice types.Currency

+ type HostOldExternalSettings struct

+ AcceptingContracts bool

+ Collateral types.Currency

+ ContractPrice types.Currency

+ DownloadBandwidthPrice types.Currency

+ MaxCollateral types.Currency

+ MaxDownloadBatchSize uint64

+ MaxDuration types.BlockHeight

+ MaxReviseBatchSize uint64

+ NetAddress NetAddress

+ RemainingStorage uint64

+ RevisionNumber uint64

+ SectorSize uint64

+ StoragePrice types.Currency

+ TotalStorage uint64

+ UnlockHash types.UnlockHash

+ UploadBandwidthPrice types.Currency

+ Version string

+ WindowSize types.BlockHeight

type KeyManager

+ LastAddresses func(n uint64) ([]types.UnlockHash, error)

+ type LoopChallengeRequest struct

+ Challenge [16]byte

+ type LoopContractAdditions struct

+ Inputs []types.SiacoinInput

+ Outputs []types.SiacoinOutput

+ Parents []types.Transaction

+ type LoopContractSignatures struct

+ ContractSignatures []types.TransactionSignature

+ RevisionSignature types.TransactionSignature

+ type LoopFormContractRequest struct

+ RenterKey types.SiaPublicKey

+ Transactions []types.Transaction

+ type LoopKeyExchangeRequest struct

+ Ciphers []types.Specifier

+ PublicKey crypto.X25519PublicKey

+ type LoopKeyExchangeResponse struct

+ Cipher types.Specifier

+ PublicKey crypto.X25519PublicKey

+ Signature []byte

+ type LoopLockRequest struct

+ ContractID types.FileContractID

+ Signature []byte

+ Timeout uint64

+ type LoopLockResponse struct

+ Acquired bool

+ NewChallenge [16]byte

+ Revision types.FileContractRevision

+ Signatures []types.TransactionSignature

+ type LoopReadRequest struct

+ MerkleProof bool

+ NewMissedProofValues []types.Currency

+ NewRevisionNumber uint64

+ NewValidProofValues []types.Currency

+ Sections []LoopReadRequestSection

+ Signature []byte

+ type LoopReadRequestSection struct

+ Length uint32

+ MerkleRoot [32]byte

+ Offset uint32

+ type LoopReadResponse struct

+ Data []byte

+ MerkleProof []crypto.Hash

+ Signature []byte

+ type LoopRenewContractRequest struct

+ RenterKey types.SiaPublicKey

+ Transactions []types.Transaction

+ type LoopSectorRootsRequest struct

+ NewMissedProofValues []types.Currency

+ NewRevisionNumber uint64

+ NewValidProofValues []types.Currency

+ NumRoots uint64

+ RootOffset uint64

+ Signature []byte

+ type LoopSectorRootsResponse struct

+ MerkleProof []crypto.Hash

+ SectorRoots []crypto.Hash

+ Signature []byte

+ type LoopSettingsResponse struct

+ Settings []byte

+ type LoopWriteAction struct

+ A uint64

+ B uint64

+ Data []byte

+ Type types.Specifier

+ type LoopWriteMerkleProof struct

+ NewMerkleRoot crypto.Hash

+ OldLeafHashes []crypto.Hash

+ OldSubtreeHashes []crypto.Hash

+ type LoopWriteRequest struct

+ Actions []LoopWriteAction

+ MerkleProof bool

+ NewMissedProofValues []types.Currency

+ NewRevisionNumber uint64

+ NewValidProofValues []types.Currency

+ type LoopWriteResponse struct

+ Signature []byte

type ProductionDependencies

+ func (pd *ProductionDependencies) Open(s string) (File, error)

+ type RPCError struct

+ Data []byte

+ Description string

+ Type types.Specifier

+ func (e *RPCError) Error() string

+ type RecoverableContract struct

+ HostPublicKey types.SiaPublicKey

+ ID types.FileContractID

+ InputParentID types.SiacoinOutputID

+ StartHeight types.BlockHeight

+ TxnFee types.Currency

type Renter

+ CreateBackup func(dst string, secret []byte) error

+ CreateDir func(siaPath SiaPath) error

+ DeleteDir func(siaPath SiaPath) error

+ DirList func(siaPath SiaPath) ([]DirectoryInfo, []FileInfo, error)

+ InitRecoveryScan func() error

+ LoadBackup func(src string, secret []byte) error

+ RecoverableContracts func() []RecoverableContract

+ RecoveryScanStatus func() (bool, types.BlockHeight)

+ SetFilterMode func(fm FilterMode, hosts []types.SiaPublicKey) error

+ type RenterHostSession struct

+ func (s *RenterHostSession) ReadRPCID() (rpcID types.Specifier, err error)

+ func (s *RenterHostSession) ReadRequest(req interface{}, maxLen uint64) error

+ func (s *RenterHostSession) ReadResponse(resp interface{}, maxLen uint64) error

+ func (s *RenterHostSession) WriteRequest(rpcID types.Specifier, req interface{}) error

+ func (s *RenterHostSession) WriteResponse(resp interface{}, err error) error

type RenterSettings

+ IPViolationsCheck bool

+ type SiaPath struct

+ Path string

+ func NewSiaPath(s string) (SiaPath, error)

+ func RootSiaPath() SiaPath

+ func (sp *SiaPath) LoadString(s string) error

+ func (sp *SiaPath) UnmarshalJSON(b []byte) error

+ func (sp SiaPath) Dir() (SiaPath, error)

+ func (sp SiaPath) Equals(siaPath SiaPath) bool

+ func (sp SiaPath) IsRoot() bool

+ func (sp SiaPath) Join(s string) (SiaPath, error)

+ func (sp SiaPath) MarshalJSON() ([]byte, error)

+ func (sp SiaPath) SiaDirMetadataSysPath(dir string) string

+ func (sp SiaPath) SiaDirSysPath(dir string) string

+ func (sp SiaPath) SiaFileSysPath(dir string) string

+ func (sp SiaPath) String() string

type StorageObligation

+ TransactionID types.TransactionID

+ type Streamer interface

+ type ValuedTransaction struct

+ ConfirmedIncomingValue types.Currency

+ ConfirmedOutgoingValue types.Currency

Oct 16, 2018

Changes in this version

+ var DefaultAllowance = Allowance

+ var DefaultUsageGuideLines = UsageGuidelines

+ var PriceEstimationScope = ...

+ func RenterPayoutsPreTax(host HostDBEntry, funding, txnFee, basePrice types.Currency, ...) (renterPayout, hostPayout, hostCollateral types.Currency, err error)

type Dependencies

+ Resolver func() Resolver

type FileInfo

+ OnDisk bool

+ Recoverable bool

type Gateway

+ ForwardPort func(port string) error

type HostDBEntry

+ IPNets []string

+ LastIPNetChange time.Time

type KeyManager

+ SignTransaction func(txn *types.Transaction, toSign []crypto.Hash) error

type ProductionDependencies

+ func (*ProductionDependencies) Resolver() Resolver

+ type ProductionResolver struct

+ func (ProductionResolver) LookupIP(host string) ([]net.IP, error)

type Renter

+ SetFileTrackingPath func(siaPath, newPath string) error

+ type Resolver interface

+ LookupIP func(string) ([]net.IP, error)

+ type UnspentOutput struct

+ ConfirmationHeight types.BlockHeight

+ FundType types.Specifier

+ ID types.OutputID

+ IsWatchOnly bool

+ UnlockHash types.UnlockHash

+ Value types.Currency

+ type UsageGuidelines struct

+ ExpectedDownloadFrequency uint64

+ ExpectedRedundancy float64

+ ExpectedStorage uint64

+ ExpectedUploadFrequency uint64

type Wallet

+ AddUnlockConditions func(uc types.UnlockConditions) error

+ AddWatchAddresses func(addrs []types.UnlockHash, unused bool) error

+ RemoveWatchAddresses func(addrs []types.UnlockHash, unused bool) error

+ UnlockConditions func(addr types.UnlockHash) (types.UnlockConditions, error)

+ UnspentOutputs func() ([]UnspentOutput, error)

+ WatchAddresses func() ([]types.UnlockHash, error)

Sep 5, 2018

Changes in this version

+ const EstimatedFileContractTransactionSetSize

type ContractUtility

+ Locked bool

type ContractorSpending

+ PreviousSpending types.Currency

+ ReleaseBlock types.BlockHeight

+ WithheldFunds types.Currency

type Dependencies

+ LookupIP func(string) ([]net.IP, error)

type DownloadInfo

+ StartTimeUnix int64

type Gateway

+ DiscoverAddress func(cancel <-chan struct{}) (NetAddress, error)

type ProductionDependencies

+ func (*ProductionDependencies) LookupIP(host string) ([]net.IP, error)

type Renter

+ CancelContract func(id types.FileContractID) error

+ ClearDownloadHistory func(after, before time.Time) error

+ OldContracts func() []RenterContract

Jun 12, 2018

Changes in this version

+ var ErrHostFault = errors.New("host has returned an error")

+ var ErrWalletShutdown = errors.New("wallet is shutting down")

+ var ProdDependencies = new(ProductionDependencies)

+ func IsHostsFault(err error) bool

type ConsensusSet

+ BlockByID func(types.BlockID) (types.Block, types.BlockHeight, bool)

type ContractorSpending

+ ContractFees types.Currency

+ ContractSpendingDeprecated types.Currency

+ TotalAllocated types.Currency

type ErasureCoder

+ EncodeShards func(data [][]byte) ([][]byte, error)

type Renter

+ DownloadAsync func(params RenterDownloadParameters) error

+ File func(siaPath string) (FileInfo, error)

+ InitialScanComplete func() (bool, error)

+ Streamer func(siaPath string) (string, io.ReadSeeker, error)

type RenterContract

+ Utility ContractUtility

type RenterSettings

+ StreamCacheSize uint64

type StorageObligation

+ ContractCost types.Currency

+ DataSize uint64

+ ExpirationHeight types.BlockHeight

+ LockedCollateral types.Currency

+ ObligationId types.FileContractID

+ PotentialDownloadRevenue types.Currency

+ PotentialStorageRevenue types.Currency

+ PotentialUploadRevenue types.Currency

+ ProofDeadLine types.BlockHeight

+ RiskedCollateral types.Currency

+ SectorRootsCount uint64

+ TransactionFeesAdded types.Currency

type TransactionBuilder

+ UnconfirmedParents func() ([]types.Transaction, error)

Mar 13, 2018

Changes in this version

+ type Dependencies interface

+ AtLeastOne func() uint64

+ CreateFile func(string) (File, error)

+ Destruct func()

+ DialTimeout func(NetAddress, time.Duration) (net.Conn, error)

+ Disrupt func(string) bool

+ Listen func(string, string) (net.Listener, error)

+ LoadFile func(persist.Metadata, interface{}, string) error

+ MkdirAll func(string, os.FileMode) error

+ NewLogger func(string) (*persist.Logger, error)

+ OpenDatabase func(persist.Metadata, string) (*persist.BoltDatabase, error)

+ OpenFile func(string, int, os.FileMode) (File, error)

+ RandRead func([]byte) (int, error)

+ ReadFile func(string) ([]byte, error)

+ RemoveFile func(string) error

+ RenameFile func(string, string) error

+ SaveFileSync func(persist.Metadata, interface{}, string) error

+ Sleep func(time.Duration)

+ Symlink func(s1, s2 string) error

+ WriteFile func(string, []byte, os.FileMode) error

type DownloadInfo

+ Completed bool

+ DestinationType string

+ EndTime time.Time

+ Length uint64

+ Offset uint64

+ TotalDataTransferred uint64

+ type File interface

+ Name func() string

+ ReadAt func([]byte, int64) (int, error)

+ Sync func() error

+ Truncate func(int64) error

+ WriteAt func([]byte, int64) (int, error)

type KeyManager

+ NextAddresses func(uint64) ([]types.UnlockConditions, error)

+ type ProductionDependencies struct

+ func (*ProductionDependencies) AtLeastOne() uint64

+ func (*ProductionDependencies) DialTimeout(addr NetAddress, timeout time.Duration) (net.Conn, error)

+ func (*ProductionDependencies) Disrupt(string) bool

+ func (*ProductionDependencies) Listen(s1, s2 string) (net.Listener, error)

+ func (*ProductionDependencies) LoadFile(meta persist.Metadata, data interface{}, filename string) error

+ func (*ProductionDependencies) MkdirAll(s string, fm os.FileMode) error

+ func (*ProductionDependencies) NewLogger(s string) (*persist.Logger, error)

+ func (*ProductionDependencies) OpenDatabase(m persist.Metadata, s string) (*persist.BoltDatabase, error)

+ func (*ProductionDependencies) RandRead(b []byte) (int, error)

+ func (*ProductionDependencies) ReadFile(s string) ([]byte, error)

+ func (*ProductionDependencies) SaveFileSync(meta persist.Metadata, data interface{}, filename string) error

+ func (*ProductionDependencies) Sleep(d time.Duration)

+ func (*ProductionDependencies) Symlink(s1, s2 string) error

+ func (*ProductionDependencies) WriteFile(s string, b []byte, fm os.FileMode) error

+ func (pd *ProductionDependencies) CreateFile(s string) (File, error)

+ func (pd *ProductionDependencies) Destruct()

+ func (pd *ProductionDependencies) OpenFile(s string, i int, fm os.FileMode) (File, error)

+ func (pd *ProductionDependencies) RemoveFile(s string) error

+ func (pd *ProductionDependencies) RenameFile(s1 string, s2 string) error

+ type ProductionFile struct

+ func (pf *ProductionFile) Close() error

type Renter

+ ContractUtility func(id types.FileContractID) (ContractUtility, bool)

+ DownloadHistory func() []DownloadInfo

+ LoadSharedFilesASCII func(asciiSia string) ([]string, error)

+ ShareFilesASCII func(paths []string) (asciiSia string, err error)

type RenterDownloadParameters

+ SiaPath string

type RenterSettings

+ MaxDownloadSpeed int64

+ MaxUploadSpeed int64

type TransactionPool

+ TransactionConfirmed func(id types.TransactionID) bool

type Wallet

+ Height func() types.BlockHeight

+ SetSettings func(WalletSettings)

+ Settings func() WalletSettings

+ type WalletSettings struct

+ NoDefrag bool

Dec 19, 2017

Changes in this version

+ type ContractUtility struct

+ GoodForRenew bool

+ GoodForUpload bool

+ type ContractorSpending struct

+ ContractSpending types.Currency

+ DownloadSpending types.Currency

+ StorageSpending types.Currency

+ Unspent types.Currency

+ UploadSpending types.Currency

type DownloadWriter

+ Close func() error

type FileInfo

+ LocalPath string

+ UploadedBytes uint64

type Gateway

+ Online func() bool

type Renter

+ PeriodSpending func() ContractorSpending

type RenterContract

+ Transaction types.Transaction

type Wallet

+ DustThreshold func() types.Currency

Jul 25, 2017

Changes in this version

+ type DownloadWriter interface

+ Destination func() string

+ WriteAt func(b []byte, off int64) (int, error)

type HostDBEntry

+ HistoricFailedInteractions float64

+ HistoricSuccessfulInteractions float64

+ LastHistoricUpdate types.BlockHeight

+ RecentFailedInteractions float64

+ RecentSuccessfulInteractions float64

type HostScoreBreakdown

+ ConversionRate float64

+ InteractionAdjustment float64

type Renter

+ EstimateHostScore func(entry HostDBEntry) HostScoreBreakdown

type RenterContract

+ GoodForRenew bool

+ GoodForUpload bool

+ type RenterDownloadParameters struct

+ Async bool

+ Destination string

+ Httpwriter io.Writer

+ Length uint64

+ Offset uint64

+ Siapath string

type TransactionPool

+ Broadcast func(ts []types.Transaction)

+ Transaction func(id types.TransactionID) (txn types.Transaction, unconfirmedParents []types.Transaction, exists bool)

+ type TransactionPoolDiff struct

+ AppliedTransactions []*UnconfirmedTransactionSet

+ RevertedTransactions []TransactionSetID

+ type TransactionSetID crypto.Hash

+ type UnconfirmedTransactionSet struct

+ Change *ConsensusChange

+ ID TransactionSetID

+ IDs []types.TransactionID

+ Sizes []uint64

+ Transactions []types.Transaction

type Wallet

+ SendSiacoinsMulti func(outputs []types.SiacoinOutput) ([]types.Transaction, error)

May 22, 2017

Changes in this version

type EncryptionManager

+ ChangeKey func(masterKey crypto.TwofishKey, newKey crypto.TwofishKey) error

type ProcessedInput

+ ParentID types.OutputID

type ProcessedOutput

+ ID types.OutputID

type Wallet

+ Rescanning func() bool

Apr 14, 2017

Changes in this version

+ const ContractManagerDir

+ var HostConnectabilityStatusChecking = HostConnectabilityStatus("checking")

+ var HostConnectabilityStatusConnectable = HostConnectabilityStatus("connectable")

+ var HostConnectabilityStatusNotConnectable = HostConnectabilityStatus("not connectable")

+ var HostWorkingStatusChecking = HostWorkingStatus("checking")

+ var HostWorkingStatusNotWorking = HostWorkingStatus("not working")

+ var HostWorkingStatusWorking = HostWorkingStatus("working")

type EncryptionManager

+ InitFromSeed func(masterKey crypto.TwofishKey, seed Seed) error

+ Reset func() error

type Host

+ ConnectabilityStatus func() HostConnectabilityStatus

+ WorkingStatus func() HostWorkingStatus

+ type HostConnectabilityStatus string

type HostScoreBreakdown

+ Score types.Currency

+ type HostWorkingStatus string

type KeyManager

+ SweepSeed func(seed Seed) (coins, funds types.Currency, err error)

type StorageFolderMetadata

+ Index uint16

+ ProgressDenominator uint64

+ ProgressNumerator uint64

type StorageManager

+ RemoveSectorBatch func(sectorRoots []crypto.Hash) error

Mar 16, 2017

Changes in this version

type DownloadInfo

+ Error string

type Host

+ StorageObligations func() []StorageObligation

+ type StorageObligation struct

+ NegotiationHeight types.BlockHeight

+ ObligationStatus uint64

+ OriginConfirmed bool

+ ProofConfirmed bool

+ ProofConstructed bool

+ RevisionConfirmed bool

+ RevisionConstructed bool

Feb 28, 2017

Changes in this version

type ConsensusChange

+ TryTransactionSet func([]types.Transaction) (ConsensusChange, error)

type Host

+ PublicKey func() types.SiaPublicKey

type HostDBEntry

+ HistoricDowntime time.Duration

+ HistoricUptime time.Duration

+ type HostScoreBreakdown struct

+ AgeAdjustment float64

+ BurnAdjustment float64

+ CollateralAdjustment float64

+ PriceAdjustment float64

+ StorageRemainingAdjustment float64

+ UptimeAdjustment float64

+ VersionAdjustment float64

+ type MerkleRootSet []crypto.Hash

+ func (mrs *MerkleRootSet) UnmarshalJSON(b []byte) error

+ func (mrs MerkleRootSet) MarshalJSON() ([]byte, error)

type Renter

+ Host func(pk types.SiaPublicKey) (HostDBEntry, bool)

+ PriceEstimation func() RenterPriceEstimation

+ ScoreBreakdown func(entry HostDBEntry) HostScoreBreakdown

type RenterContract

+ HostPublicKey types.SiaPublicKey

+ type RenterPriceEstimation struct

+ DownloadTerabyte types.Currency

+ FormContracts types.Currency

+ StorageTerabyteMonth types.Currency

+ UploadTerabyte types.Currency

Jan 19, 2017

Changes in this version

type HostDBEntry

+ FirstSeen types.BlockHeight

+ ScanHistory HostDBScans

+ type HostDBScan struct

+ Success bool

+ Timestamp time.Time

+ type HostDBScans []HostDBScan

+ func (s HostDBScans) Len() int

+ func (s HostDBScans) Less(i, j int) bool

+ func (s HostDBScans) Swap(i, j int)

type Renter

+ CurrentPeriod func() types.BlockHeight

type RenterContract

+ ContractFee types.Currency

+ DownloadSpending types.Currency

+ SiafundFee types.Currency

+ StartHeight types.BlockHeight

+ StorageSpending types.Currency

+ TotalCost types.Currency

+ TxnFee types.Currency

+ UploadSpending types.Currency

Oct 25, 2016

Changes in this version

type ConsensusChange

+ ChildTarget types.Target

+ MinimumValidChildTimestamp types.Timestamp

type Explorer

+ LatestBlockFacts func() BlockFacts

type NetAddress

+ func (na NetAddress) IsLocal() bool

+ func (na NetAddress) IsStdValid() error

type Peer

+ Local bool

type StorageManager

+ AddSectorBatch func(sectorRoots []crypto.Hash, expiryHeight types.BlockHeight) error

Jul 26, 2016

Changes in this version

+ var ErrIncompleteTransactions = errors.New(...)

type ConsensusSet

+ Flush func() error

Jun 29, 2016

Changes in this version

+ const AcceptResponse

+ const ExplorerDir

+ const MaxEncodedNetAddressLength

+ const MinerDir

+ const NegotiateDownloadTime

+ const NegotiateFileContractRevisionTime

+ const NegotiateFileContractTime

+ const NegotiateMaxDownloadActionRequestSize

+ const NegotiateMaxErrorSize

+ const NegotiateMaxFileContractRevisionSize

+ const NegotiateMaxFileContractSetLen

+ const NegotiateMaxHostExternalSettingsLen

+ const NegotiateMaxSiaPubkeySize

+ const NegotiateMaxTransactionSignatureSize

+ const NegotiateMaxTransactionSignaturesSize

+ const NegotiateRecentRevisionTime

+ const NegotiateRenewContractTime

+ const NegotiateSettingsTime

+ const PublicKeysPerSeed

+ const SeedChecksumSize

+ const StopResponse

+ const StorageManagerDir

+ const TransactionSetSizeLimit

+ const TransactionSizeLimit

+ const WalletSeedPreloadDepth

+ const WellConnectedThreshold

+ var ActionDelete = types.Specifier

+ var ActionInsert = types.Specifier

+ var ActionModify = types.Specifier

+ var BlockBytesPerMonthTerabyte = BytesPerTerabyte.Mul64(4320)

+ var BytesPerTerabyte = types.NewCurrency64(1e12)

+ var ConsensusChangeBeginning = ConsensusChangeID

+ var ConsensusChangeRecent = ConsensusChangeID

+ var ErrAnnNotAnnouncement = errors.New("provided data does not form a recognized host announcement")

+ var ErrAnnUnrecognizedSignature = errors.New("the signature provided in the host announcement is not recognized")

+ var ErrBadEncryptionKey = errors.New("provided encryption key is incorrect")

+ var ErrBlockKnown = errors.New("block already present in database")

+ var ErrBlockUnsolved = errors.New("block does not meet target")

+ var ErrDuplicateTransactionSet = errors.New("transaction set contains only duplicate transactions")

+ var ErrInvalidArbPrefix = errors.New("transaction contains non-standard arbitrary data")

+ var ErrInvalidConsensusChangeID = errors.New("consensus subscription has invalid id - files are inconsistent")

+ var ErrLargeTransaction = errors.New("transaction is too large for this transaction pool")

+ var ErrLargeTransactionSet = errors.New("transaction set is too large for this transaction pool")

+ var ErrLockedWallet = errors.New("wallet must be unlocked before it can be used")

+ var ErrLowBalance = errors.New("insufficient balance")

+ var ErrPotentialDoubleSpend = errors.New(...)

+ var ErrRevisionCoveredFields = errors.New(...)

+ var ErrRevisionSigCount = errors.New("file contract revision has the wrong number of transaction signatures")

+ var ErrStopResponse = errors.New("sender wishes to stop communicating")

+ var PrefixNonSia = types.Specifier

+ var RPCDownload = types.Specifier

+ var RPCFormContract = types.Specifier

+ var RPCRecentRevision = types.Specifier

+ var RPCRenewContract = types.Specifier

+ var RPCReviseContract = types.Specifier

+ var RPCSettings = types.Specifier

+ var SectorSize = func() uint64 { ... }()

+ var TransactionPoolDir = "transactionpool"

+ func CalculateFee(ts []types.Transaction) types.Currency

+ func CreateAnnouncement(addr NetAddress, pk types.SiaPublicKey, sk crypto.SecretKey) (signedAnnouncement []byte, err error)

+ func ReadNegotiationAcceptance(r io.Reader) error

+ func SeedToString(seed Seed, did mnemonics.DictionaryID) (string, error)

+ func VerifyFileContractRevisionTransactionSignatures(fcr types.FileContractRevision, tsigs []types.TransactionSignature, ...) error

+ func WriteNegotiationAcceptance(w io.Writer) error

+ func WriteNegotiationRejection(w io.Writer, err error) error

+ func WriteNegotiationStop(w io.Writer) error

+ type Allowance struct

+ Funds types.Currency

+ Hosts uint64

+ Period types.BlockHeight

+ RenewWindow types.BlockHeight

+ type BlockFacts struct

+ ActiveContractCost types.Currency

+ ActiveContractCount uint64

+ ActiveContractSize types.Currency

+ ArbitraryDataCount uint64

+ BlockID types.BlockID

+ Difficulty types.Currency

+ EstimatedHashrate types.Currency

+ FileContractCount uint64

+ FileContractRevisionCount uint64

+ Height types.BlockHeight

+ MaturityTimestamp types.Timestamp

+ MinerFeeCount uint64

+ MinerPayoutCount uint64

+ SiacoinInputCount uint64

+ SiacoinOutputCount uint64

+ SiafundInputCount uint64

+ SiafundOutputCount uint64

+ StorageProofCount uint64

+ Target types.Target

+ TotalCoins types.Currency

+ TotalContractCost types.Currency

+ TotalContractSize types.Currency

+ TotalRevisionVolume types.Currency

+ TransactionCount uint64

+ TransactionSignatureCount uint64

+ type BlockManager interface

+ BlocksMined func() (goodBlocks, staleBlocks int)

+ HeaderForWork func() (types.BlockHeader, types.Target, error)

+ SubmitHeader func(types.BlockHeader) error

+ type CPUMiner interface

+ CPUHashrate func() int

+ CPUMining func() bool

+ StartCPUMining func()

+ StopCPUMining func()

type ConsensusChange

+ DelayedSiacoinOutputDiffs []DelayedSiacoinOutputDiff

+ ID ConsensusChangeID

+ SiafundPoolDiffs []SiafundPoolDiff

+ Synced bool

+ func (cc ConsensusChange) Append(cc2 ConsensusChange) ConsensusChange

+ type ConsensusChangeID crypto.Hash

+ type ConsensusConflict string

+ func NewConsensusConflict(s string) ConsensusConflict

+ func (cc ConsensusConflict) Error() string

type ConsensusSet

+ BlockAtHeight func(types.BlockHeight) (types.Block, bool)

+ Height func() types.BlockHeight

+ MinimumValidChildTimestamp func(types.BlockID) (types.Timestamp, bool)

+ StorageProofSegment func(types.FileContractID) (uint64, error)

+ Synced func() bool

+ TryTransactionSet func([]types.Transaction) (ConsensusChange, error)

+ Unsubscribe func(ConsensusSetSubscriber)

type ConsensusSetSubscriber

+ ProcessConsensusChange func(ConsensusChange)

+ type DownloadAction struct

+ Length uint64

+ MerkleRoot crypto.Hash

+ Offset uint64

type DownloadInfo

+ SiaPath string

+ type EncryptionManager interface

+ Encrypt func(masterKey crypto.TwofishKey) (Seed, error)

+ Encrypted func() bool

+ Lock func() error

+ Unlock func(masterKey crypto.TwofishKey) error

+ Unlocked func() bool

+ type ErasureCoder interface

+ Encode func(data []byte) ([][]byte, error)

+ MinPieces func() int

+ NumPieces func() int

+ Recover func(pieces [][]byte, n uint64, w io.Writer) error

+ type Explorer interface

+ Block func(types.BlockID) (types.Block, types.BlockHeight, bool)

+ BlockFacts func(types.BlockHeight) (BlockFacts, bool)

+ Close func() error

+ FileContractHistory func(types.FileContractID) (fc types.FileContract, fcrs []types.FileContractRevision, fcExists bool, ...)

+ FileContractID func(types.FileContractID) []types.TransactionID

+ SiacoinOutput func(types.SiacoinOutputID) (types.SiacoinOutput, bool)

+ SiacoinOutputID func(types.SiacoinOutputID) []types.TransactionID

+ SiafundOutput func(types.SiafundOutputID) (types.SiafundOutput, bool)

+ SiafundOutputID func(types.SiafundOutputID) []types.TransactionID

+ Transaction func(types.TransactionID) (types.Block, types.BlockHeight, bool)

+ UnlockHash func(types.UnlockHash) []types.TransactionID

type FileInfo

+ Expiration types.BlockHeight

+ Filesize uint64

+ Redundancy float64

+ Renewing bool

+ SiaPath string

type FileUploadParams

+ ErasureCode ErasureCoder

+ SiaPath string

+ Source string

type Gateway

+ UnregisterConnectCall func(string)

+ UnregisterRPC func(string)

type Host

+ AnnounceAddress func(NetAddress) error

+ ExternalSettings func() HostExternalSettings

+ FinancialMetrics func() HostFinancialMetrics

+ InternalSettings func() HostInternalSettings

+ NetworkMetrics func() HostNetworkMetrics

+ SetInternalSettings func(HostInternalSettings) error

type HostAnnouncement

+ NetAddress NetAddress

+ PublicKey types.SiaPublicKey

+ Specifier types.Specifier

+ type HostDBEntry struct

+ PublicKey types.SiaPublicKey

+ type HostExternalSettings struct

+ AcceptingContracts bool

+ Collateral types.Currency

+ ContractPrice types.Currency

+ DownloadBandwidthPrice types.Currency

+ MaxCollateral types.Currency

+ MaxDownloadBatchSize uint64

+ MaxDuration types.BlockHeight

+ MaxReviseBatchSize uint64

+ NetAddress NetAddress

+ RemainingStorage uint64

+ RevisionNumber uint64

+ SectorSize uint64

+ StoragePrice types.Currency

+ TotalStorage uint64

+ UnlockHash types.UnlockHash

+ UploadBandwidthPrice types.Currency

+ Version string

+ WindowSize types.BlockHeight

+ type HostFinancialMetrics struct

+ ContractCompensation types.Currency

+ ContractCount uint64

+ DownloadBandwidthRevenue types.Currency

+ LockedStorageCollateral types.Currency

+ LostRevenue types.Currency

+ LostStorageCollateral types.Currency

+ PotentialContractCompensation types.Currency

+ PotentialDownloadBandwidthRevenue types.Currency

+ PotentialStorageRevenue types.Currency

+ PotentialUploadBandwidthRevenue types.Currency

+ RiskedStorageCollateral types.Currency

+ StorageRevenue types.Currency

+ TransactionFeeExpenses types.Currency

+ UploadBandwidthRevenue types.Currency

+ type HostInternalSettings struct

+ AcceptingContracts bool

+ Collateral types.Currency

+ CollateralBudget types.Currency

+ MaxCollateral types.Currency

+ MaxDownloadBatchSize uint64

+ MaxDuration types.BlockHeight

+ MaxReviseBatchSize uint64

+ MinContractPrice types.Currency

+ MinDownloadBandwidthPrice types.Currency

+ MinStoragePrice types.Currency

+ MinUploadBandwidthPrice types.Currency

+ NetAddress NetAddress

+ WindowSize types.BlockHeight

+ type HostNetworkMetrics struct

+ DownloadCalls uint64

+ ErrorCalls uint64

+ FormContractCalls uint64

+ RenewCalls uint64

+ ReviseCalls uint64

+ SettingsCalls uint64

+ UnrecognizedCalls uint64

+ type KeyManager interface

+ AllAddresses func() []types.UnlockHash

+ AllSeeds func() ([]Seed, error)

+ CreateBackup func(string) error

+ Load033xWallet func(crypto.TwofishKey, string) error

+ LoadSeed func(crypto.TwofishKey, Seed) error

+ LoadSiagKeys func(crypto.TwofishKey, []string) error

+ NextAddress func() (types.UnlockConditions, error)

+ PrimarySeed func() (Seed, uint64, error)

type NetAddress

+ func DecodeAnnouncement(fullAnnouncement []byte) (na NetAddress, spk types.SiaPublicKey, err error)

+ func (na NetAddress) IsLoopback() bool

+ func (na NetAddress) IsValid() error

+ type Peer struct

+ Inbound bool

+ NetAddress NetAddress

+ Version string

type PeerConn

+ RPCAddr func() NetAddress

+ type ProcessedInput struct

+ FundType types.Specifier

+ RelatedAddress types.UnlockHash

+ Value types.Currency

+ WalletAddress bool

+ type ProcessedOutput struct

+ FundType types.Specifier

+ MaturityHeight types.BlockHeight

+ RelatedAddress types.UnlockHash

+ Value types.Currency

+ WalletAddress bool

+ type ProcessedTransaction struct

+ ConfirmationHeight types.BlockHeight

+ ConfirmationTimestamp types.Timestamp

+ Inputs []ProcessedInput

+ Outputs []ProcessedOutput

+ Transaction types.Transaction

+ TransactionID types.TransactionID

type Renter

+ ActiveHosts func() []HostDBEntry

+ AllHosts func() []HostDBEntry

+ Close func() error

+ Contracts func() []RenterContract

+ FinancialMetrics func() RenterFinancialMetrics

+ LoadSharedFiles func(source string) ([]string, error)

+ SetSettings func(RenterSettings) error

+ Settings func() RenterSettings

+ type RenterContract struct

+ FileContract types.FileContract

+ ID types.FileContractID

+ LastRevision types.FileContractRevision

+ LastRevisionTxn types.Transaction

+ MerkleRoots []crypto.Hash

+ NetAddress NetAddress

+ SecretKey crypto.SecretKey

+ func (rc *RenterContract) EndHeight() types.BlockHeight

+ func (rc *RenterContract) RenterFunds() types.Currency

+ type RenterFinancialMetrics struct

+ ContractSpending types.Currency

+ DownloadSpending types.Currency

+ StorageSpending types.Currency

+ UploadSpending types.Currency

+ type RenterSettings struct

+ Allowance Allowance

+ type RevisionAction struct

+ Data []byte

+ Offset uint64

+ SectorIndex uint64

+ Type types.Specifier

+ type Seed [crypto.EntropySize]byte

+ func StringToSeed(str string, did mnemonics.DictionaryID) (Seed, error)

type SiafundPoolDiff

+ Direction DiffDirection

+ type StorageFolderMetadata struct

+ Capacity uint64

+ CapacityRemaining uint64

+ FailedReads uint64

+ FailedWrites uint64

+ Path string

+ SuccessfulReads uint64

+ SuccessfulWrites uint64

+ type StorageManager interface

+ AddSector func(sectorRoot crypto.Hash, expiryHeight types.BlockHeight, sectorData []byte) error

+ AddStorageFolder func(path string, size uint64) error

+ Close func() error

+ DeleteSector func(sectorRoot crypto.Hash) error

+ ReadSector func(sectorRoot crypto.Hash) ([]byte, error)

+ RemoveSector func(sectorRoot crypto.Hash, expiryHeight types.BlockHeight) error

+ RemoveStorageFolder func(index int, force bool) error

+ ResetStorageFolderHealth func(index int) error

+ ResizeStorageFolder func(index int, newSize uint64) error

+ StorageFolders func() []StorageFolderMetadata

+ type TestMiner interface

+ AddBlock func() (types.Block, error)

+ BlockForWork func() (types.Block, types.Target, error)

+ Close func() error

+ FindBlock func() (types.Block, error)

+ SolveBlock func(types.Block, types.Target) (types.Block, bool)

+ type TransactionBuilder interface

+ AddArbitraryData func(arb []byte) uint64

+ AddFileContract func(types.FileContract) uint64

+ AddFileContractRevision func(types.FileContractRevision) uint64

+ AddMinerFee func(fee types.Currency) uint64

+ AddParents func([]types.Transaction)

+ AddSiacoinInput func(types.SiacoinInput) uint64

+ AddSiacoinOutput func(types.SiacoinOutput) uint64

+ AddSiafundInput func(types.SiafundInput) uint64

+ AddSiafundOutput func(types.SiafundOutput) uint64

+ AddStorageProof func(types.StorageProof) uint64

+ AddTransactionSignature func(types.TransactionSignature) uint64

+ Drop func()

+ FundSiacoins func(amount types.Currency) error

+ FundSiafunds func(amount types.Currency) error

+ Sign func(wholeTransaction bool) ([]types.Transaction, error)

+ View func() (txn types.Transaction, parents []types.Transaction)

+ ViewAdded func() (newParents, siacoinInputs, siafundInputs, transactionSignatures []int)

type TransactionPool

+ AcceptTransactionSet func([]types.Transaction) error

+ Close func() error

+ FeeEstimation func() (minimumRecommended, maximumRecommended types.Currency)

+ TransactionList func() []types.Transaction

+ Unsubscribe func(TransactionPoolSubscriber)

type TransactionPoolSubscriber

+ ReceiveUpdatedUnconfirmedTransactions func([]types.Transaction, ConsensusChange)

type Wallet

+ AddressTransactions func(types.UnlockHash) []ProcessedTransaction

+ AddressUnconfirmedTransactions func(types.UnlockHash) []ProcessedTransaction

+ ConfirmedBalance func() (siacoinBalance types.Currency, siafundBalance types.Currency, ...)

+ SendSiacoins func(amount types.Currency, dest types.UnlockHash) ([]types.Transaction, error)

+ SendSiafunds func(amount types.Currency, dest types.UnlockHash) ([]types.Transaction, error)

+ StartTransaction func() TransactionBuilder

+ Transaction func(types.TransactionID) (ProcessedTransaction, bool)

+ Transactions func(startHeight types.BlockHeight, endHeight types.BlockHeight) ([]ProcessedTransaction, error)

+ UnconfirmedBalance func() (outgoingSiacoins types.Currency, incomingSiacoins types.Currency)

+ UnconfirmedTransactions func() []ProcessedTransaction

+ type WalletTransactionID crypto.Hash

+ func CalculateWalletTransactionID(tid types.TransactionID, oid types.OutputID) WalletTransactionID

Jun 7, 2015

Changes in this version

+ var ErrNonExtendingBlock = errors.New("block does not extend the longest fork.")

+ type ConsensusChange struct

+ AppliedBlocks []types.Block

+ FileContractDiffs []FileContractDiff

+ RevertedBlocks []types.Block

+ SiacoinOutputDiffs []SiacoinOutputDiff

+ SiafundOutputDiffs []SiafundOutputDiff

+ SiafundPoolDiff SiafundPoolDiff

type ConsensusSet

+ GenesisBlock func() types.Block

+ ValidStorageProofs func(types.Transaction) error

+ type DelayedSiacoinOutputDiff struct

+ Direction DiffDirection

+ ID types.SiacoinOutputID

+ MaturityHeight types.BlockHeight

+ SiacoinOutput types.SiacoinOutput

type DownloadInfo

+ StartTime func() time.Time

type FileInfo

+ UploadProgress func() float32

type HostDB

+ RandomHosts func(num int) []HostSettings

type HostInfo

+ PotentialProfit types.Currency

+ Profit types.Currency

type RentInfo

+ Price types.Currency

May 26, 2015

Changes in this version

+ var ErrTransactionPoolDuplicate = errors.New("transaction is a duplicate")

+ var ExternalIP = func() string { ... }()

+ type ConsensusSet interface

+ AcceptBlock func(types.Block) error

+ ChildTarget func(types.BlockID) (types.Target, bool)

+ Close func() error

+ ConsensusSetSubscribe func(ConsensusSetSubscriber)

+ CurrentBlock func() types.Block

+ EarliestChildTimestamp func(types.BlockID) (types.Timestamp, bool)

+ InCurrentPath func(types.BlockID) bool

+ Synchronize func(NetAddress) error

+ type ConsensusSetSubscriber interface

+ ReceiveConsensusSetUpdate func(revertedBlocks []types.Block, appliedBlocks []types.Block)

type Miner

+ BlockForWork func() (types.Block, crypto.Hash, types.Target)

+ SubmitBlock func(types.Block) error

type MinerInfo

+ BlocksMined int

+ BlocksPerWeek float64

+ HashRate int64

+ OrphansMined int

type WalletInfo

+ VisibleAddresses []types.UnlockHash

May 12, 2015

Changes in this version

+ const ConsensusDir

+ const GatewayDir

+ const HostDir

+ const NotifyBuffer

+ const WalletDir

+ var RenterDir = "renter"

+ var SafeMutexDelay time.Duration

+ type DiffDirection bool

+ const DiffApply

+ const DiffRevert

+ type FileContractDiff struct

+ Direction DiffDirection

+ FileContract types.FileContract

+ ID types.FileContractID

+ type FileUploadParams struct

+ Duration types.BlockHeight

+ Filename string

+ Nickname string

+ Pieces int

type Gateway

+ Address func() NetAddress

+ Broadcast func(name string, obj interface{})

+ Close func() error

+ Connect func(NetAddress) error

+ Disconnect func(NetAddress) error

+ Peers func() []NetAddress

+ RegisterConnectCall func(string, RPCFunc)

type Host

+ Address func() NetAddress

+ HostNotify func() <-chan struct{}

type HostDB

+ ActiveHosts func() []HostSettings

+ AllHosts func() []HostSettings

+ HostDBNotify func() <-chan struct{}

+ InsertHost func(HostSettings) error

+ RemoveHost func(NetAddress) error

type HostSettings

+ IPAddress NetAddress

+ type Miner interface

+ FindBlock func() (types.Block, bool, error)

+ MinerInfo func() MinerInfo

+ MinerNotify func() <-chan struct{}

+ SetThreads func(int) error

+ SolveBlock func(types.Block, types.Target) (types.Block, bool)

+ StartMining func() error

+ StopMining func() error

+ type MinerInfo struct

+ Address types.UnlockHash

+ Mining bool

+ RunningThreads int

+ State string

+ Threads int

+ type PeerConn interface

type Renter

+ DeleteFile func(nickname string) error

+ LoadSharedFile func(filename string) ([]string, error)

+ LoadSharedFilesAscii func(asciiSia string) ([]string, error)

+ RenameFile func(currentName, newName string) error

+ RenterNotify func() <-chan struct{}

+ ShareFiles func(nicknames []string, sharedest string) error

+ ShareFilesAscii func(nicknames []string) (asciiSia string, err error)

+ type SiacoinOutputDiff struct

+ Direction DiffDirection

+ ID types.SiacoinOutputID

+ SiacoinOutput types.SiacoinOutput

+ type SiafundOutputDiff struct

+ Direction DiffDirection

+ ID types.SiafundOutputID

+ SiafundOutput types.SiafundOutput

+ type SiafundPoolDiff struct

+ Adjusted types.Currency

+ Previous types.Currency

type TransactionPool

+ PurgeTransactionPool func()

+ RelayTransaction func(PeerConn) error

+ TransactionPoolNotify func() <-chan struct{}

+ TransactionPoolSubscribe func(TransactionPoolSubscriber)

+ type TransactionPoolSubscriber interface

+ ReceiveTransactionPoolUpdate func(revertedBlocks, appliedBlocks []types.Block, ...)

type Wallet

+ Close func() error

+ WalletNotify func() <-chan struct{}

Mar 17, 2015

Changes in this version

+ const AcceptTermsResponse

+ const PrefixHostAnnouncement

+ var BootstrapPeers = []NetAddress

+ var LowBalanceErr = errors.New("Insufficient Balance")

+ type ContractTerms struct

+ Collateral consensus.Currency

+ Duration consensus.BlockHeight

+ DurationStart consensus.BlockHeight

+ FileSize uint64

+ MissedProofOutputs []consensus.SiacoinOutput

+ Price consensus.Currency

+ ValidProofOutputs []consensus.SiacoinOutput

+ WindowSize consensus.BlockHeight

+ type DownloadInfo interface

+ Complete func() bool

+ Destination func() string

+ Filesize func() uint64

+ Nickname func() string

+ Received func() uint64

+ type FileInfo interface

+ Available func() bool

+ Nickname func() string

+ Repairing func() bool

+ TimeRemaining func() consensus.BlockHeight

+ type Gateway interface

+ AddPeer func(NetAddress) error

+ Bootstrap func(NetAddress) error

+ Info func() GatewayInfo

+ RPC func(NetAddress, string, RPCFunc) error

+ RandomPeer func() (NetAddress, error)

+ RegisterRPC func(string, RPCFunc)

+ RelayBlock func(consensus.Block)

+ RelayTransaction func(consensus.Transaction)

+ RemovePeer func(NetAddress) error

+ Synchronize func(NetAddress) error

+ type GatewayInfo struct

+ Address NetAddress

+ Peers []NetAddress

+ type Host interface

+ Announce func(NetAddress) error

+ Info func() HostInfo

+ NegotiateContract func(NetConn) error

+ RetrieveFile func(NetConn) error

+ SetSettings func(HostSettings)

+ Settings func(NetConn) error

+ type HostAnnouncement struct

+ IPAddress NetAddress

+ type HostDB interface

+ FlagHost func(NetAddress) error

+ Insert func(HostEntry) error

+ NumHosts func() int

+ RandomHost func() (HostEntry, error)

+ Remove func(NetAddress) error

+ type HostEntry struct

+ IPAddress NetAddress

+ type HostInfo struct

+ NumContracts int

+ StorageRemaining int64

+ type HostSettings struct

+ Collateral consensus.Currency

+ MaxDuration consensus.BlockHeight

+ MaxFilesize uint64

+ MinDuration consensus.BlockHeight

+ MinFilesize uint64

+ Price consensus.Currency

+ TotalStorage int64

+ UnlockHash consensus.UnlockHash

+ WindowSize consensus.BlockHeight

+ type NetAddress string

+ func (na NetAddress) Host() string

+ func (na NetAddress) Port() string

+ type NetConn interface

+ Addr func() NetAddress

+ type RPCFunc func(NetConn) error

+ type RentInfo struct

+ Files []string

+ type Renter interface

+ Download func(nickname, filepath string) error

+ DownloadQueue func() []DownloadInfo

+ FileList func() []FileInfo

+ Info func() RentInfo

+ Rename func(currentName, newName string) error

+ Upload func(UploadParams) error

+ type TransactionPool interface

+ AcceptTransaction func(consensus.Transaction) error

+ IsStandardTransaction func(consensus.Transaction) error

+ TransactionSet func() ([]consensus.Transaction, error)

+ UnconfirmedSiacoinOutputDiffs func() []consensus.SiacoinOutputDiff

+ type UploadParams struct

+ Duration consensus.BlockHeight

+ Filename string

+ Nickname string

+ Pieces int

+ type Wallet interface

+ AddArbitraryData func(id string, arb string) (consensus.Transaction, uint64, error)

+ AddFileContract func(id string, fc consensus.FileContract) (consensus.Transaction, uint64, error)

+ AddMinerFee func(id string, fee consensus.Currency) (consensus.Transaction, uint64, error)

+ AddOutput func(id string, output consensus.SiacoinOutput) (consensus.Transaction, uint64, error)

+ AddSiacoinInput func(id string, input consensus.SiacoinInput) (consensus.Transaction, uint64, error)

+ AddSignature func(id string, sig consensus.TransactionSignature) (consensus.Transaction, uint64, error)

+ AddStorageProof func(id string, sp consensus.StorageProof) (consensus.Transaction, uint64, error)

+ Balance func(full bool) consensus.Currency

+ CoinAddress func() (consensus.UnlockHash, consensus.UnlockConditions, error)

+ FundTransaction func(id string, amount consensus.Currency) (consensus.Transaction, error)

+ Info func() WalletInfo

+ RegisterTransaction func(consensus.Transaction) (id string, err error)

+ SignTransaction func(id string, wholeTransaction bool) (consensus.Transaction, error)

+ SpendCoins func(amount consensus.Currency, dest consensus.UnlockHash) (consensus.Transaction, error)

+ TimelockedCoinAddress func(unlockHeight consensus.BlockHeight) (consensus.UnlockHash, consensus.UnlockConditions, error)

+ type WalletInfo struct

+ Balance consensus.Currency

+ FullBalance consensus.Currency

+ NumAddresses int