Package explorer provides a glimpse into what the Sia network currently looks like.

Package gateway connects a Sia node to the Sia flood network.

Package host is an implementation of the host module, and is responsible for participating in the storage ecosystem, turning available disk space an internet bandwidth into profit for the user.

Package miner is responsible for creating and submitting siacoin blocks.

Package renter is responsible for uploading and downloading files on the sia network.

CalculateFee returns the fee-per-byte of a transaction set.

CalculateWalletTransactionID is a helper function for determining the id of a wallet transaction.

CreateAnnouncement will take a host announcement and encode it, returning the exact []byte that should be added to the arbitrary data of a transaction.

DecodeAnnouncement decodes announcement bytes into a host announcement, verifying the prefix and the signature.

IsHostsFault indicates if a returned error is the host's fault.

NewConsensusConflict returns a consensus conflict, which implements the error interface.

ReadNegotiationAcceptance reads an accept/reject response from r (usually a net.Conn).

SeedToString converts a wallet seed to a human friendly string.

StringToSeed converts a string to a wallet seed.

VerifyFileContractRevisionTransactionSignatures checks that the signatures on a file contract revision are valid and cover the right fields.

WriteNegotiationAcceptance writes the 'accept' response to w (usually a net.Conn).

WriteNegotiationRejection will write a rejection response to w (usually a net.Conn) and return the input error.

WriteNegotiationStop writes the 'stop' response to w (usually a net.Conn).

AcceptResponse is the response given to an RPC call to indicate acceptance, i.e.

ConsensusDir is the name of the directory used for all of the consensus persistence files.

ContractManagerDir is the standard name used for the directory that contains all files directly related to the contract manager.

DiffApply indicates that a diff is being applied to the consensus set.

DiffRevert indicates that a diff is being reverted from the consensus set.

EstimatedFileContractTransactionSetSize is the estimated blockchain size of a transaction set between a renter and a host that contains a file contract.

ExplorerDir is the name of the directory that is typically used for the explorer.

GatewayDir is the name of the directory used to store the gateway's persistent data.

HostDir names the directory that contains the host persistence.

MaxEncodedNetAddressLength is the maximum length of a NetAddress encoded with the encode package.

MinerDir is the name of the directory that is used to store the miner's persistent data.

NegotiateDownloadTime defines the amount of time that the renter and host have to negotiate a download request batch.

NegotiateFileContractRevisionTime defines the minimum amount of time that the renter and host have to negotiate a file contract revision.

NegotiateFileContractTime defines the amount of time that the renter and host have to negotiate a file contract.

NegotiateMaxDownloadActionRequestSize defines the maximum size that a download request can be.

NegotiateMaxErrorSize indicates the maximum number of bytes that can be used to encode an error being sent during negotiation.

NegotiateMaxFileContractRevisionSize specifies the maximum size that a file contract revision is allowed to have when being sent over the wire during negotiation.

NegotiateMaxFileContractSetLen determines the maximum allowed size of a transaction set that can be sent when trying to negotiate a file contract.

NegotiateMaxHostExternalSettingsLen is the maximum allowed size of an encoded HostExternalSettings.

NegotiateMaxSiaPubkeySize defines the maximum size that a SiaPubkey is allowed to be when being sent over the wire during negotiation.

NegotiateMaxTransactionSignatureSize defines the maximum size that a transaction signature is allowed to be when being sent over the wire during negotiation.

NegotiateMaxTransactionSignaturesSize defines the maximum size that a transaction signature slice is allowed to be when being sent over the wire during negotiation.

NegotiateRecentRevisionTime establishes the minimum amount of time that the connection deadline is expected to be set to when a recent file contract revision is being requested from the host.

NegotiateRenewContractTime defines the minimum amount of time that the renter and host have to negotiate a final contract renewal.

PublicKeysPerSeed define the number of public keys that get pregenerated for a seed at startup when searching for balances in the blockchain.

RenterDir is the name of the directory that is used to store the renter's persistent data.

SeedChecksumSize is the number of bytes that are used to checksum addresses to prevent accidental spending.

StopResponse is the response given to an RPC call to indicate graceful termination, i.e.

StorageManagerDir is standard name used for the directory that contains all of the storage manager files.

TransactionSetSizeLimit defines the largest set of dependent unconfirmed transactions that will be accepted by the transaction pool.

TransactionSizeLimit defines the size of the largest transaction that will be accepted by the transaction pool according to the IsStandard rules.

WalletDir is the directory that contains the wallet persistence.

ActionDelete is the specifier for a RevisionAction that deletes a sector.

ActionInsert is the specifier for a RevisionAction that inserts a sector.

ActionModify is the specifier for a RevisionAction that modifies sector data.

BlockBytesPerMonthTerabyte is the conversion rate between block-bytes and month-TB.

BootstrapPeers is a list of peers that can be used to find other peers - when a client first connects to the network, the only options for finding peers are either manual entry of peers or to use a hardcoded bootstrap point.

BytesPerTerabyte is the conversion rate between bytes and terabytes.

ConsensusChangeBeginning is a special consensus change id that tells the consensus set to provide all consensus changes starting from the very first diff, which includes the genesis block diff.

ConsensusChangeRecent is a special consensus change id that tells the consensus set to provide the most recent consensus change, instead of starting from a specific value (which may not be known to the caller).

ErrAnnNotAnnouncement indicates that the provided host announcement does not use a recognized specifier, indicating that it's either not a host announcement or it's not a recognized version of a host announcement.

ErrAnnUnrecognizedSignature is returned when the signature in a host announcement is not a type of signature that is recognized.

ErrBadEncryptionKey is returned if the incorrect encryption key to a file is provided.

ErrBlockKnown is an error indicating that a block is already in the database.

ErrBlockUnsolved indicates that a block did not meet the required POW target.

ErrDuplicateTransactionSet is the error that gets returned if a duplicate transaction set is given to the transaction pool.

ErrHostFault is an error that is usually extended to indicate that an error is the host's fault.

ErrIncompleteTransactions is returned if the wallet has incomplete transactions being built that are using all of the current outputs, and therefore the wallet is unable to spend money despite it not technically being 'unconfirmed' yet.

ErrInvalidArbPrefix is the error that gets returned if a transaction is submitted to the transaction pool which contains a prefix that is not recognized.

ErrInvalidConsensusChangeID indicates that ConsensusSetPersistSubscribe was called with a consensus change id that is not recognized.

ErrLargeTransaction is the error that gets returned if a transaction provided to the transaction pool is larger than what is allowed by the IsStandard rules.

ErrLargeTransactionSet is the error that gets returned if a transaction set given to the transaction pool is larger than the limit placed by the IsStandard rules of the transaction pool.

ErrLockedWallet is returned when an action cannot be performed due to the wallet being locked.

ErrLowBalance is returned if the wallet does not have enough funds to complete the desired action.

ErrNonExtendingBlock indicates that a block is valid but does not result in a fork that is the heaviest known fork - the consensus set has not changed as a result of seeing the block.

ErrRevisionCoveredFields is returned if there is a covered fields object in a transaction signature which has the 'WholeTransaction' field set to true, meaning that miner fees cannot be added to the transaction without invalidating the signature.

ErrRevisionSigCount is returned when a file contract revision has the wrong number of transaction signatures.

ErrStopResponse is the error returned by ReadNegotiationAcceptance when it reads the StopResponse string.

ErrWalletShutdown is returned when a method can't continue execution due to the wallet shutting down.

HostConnectabilityStatusChecking is returned from ConnectabilityStatus() if the host is still determining if it is connectable.

HostConnectabilityStatusConnectable is returned from ConnectabilityStatus() if the host is connectable at its configured netaddress.

HostConnectabilityStatusNotConnectable is returned from ConnectabilityStatus() if the host is not connectable at its configured netaddress.

HostWorkingStatusChecking is returned from WorkingStatus() if the host is still determining if it is working, that is, if settings calls are incrementing.

HostWorkingStatusNotWorking is returned from WorkingStatus() if the host has not received any settings calls over the duration of workingStatusFrequency.

HostWorkingStatusWorking is returned from WorkingStatus() if the host has received more than workingThreshold settings calls over the duration of workingStatusFrequency.

NegotiateSettingsTime establishes the minimum amount of time that the connection deadline is expected to be set to when settings are being requested from the host.

PrefixHostAnnouncement is used to indicate that a transaction's Arbitrary Data field contains a host announcement.

PrefixNonSia defines the prefix that should be appended to any transactions that use the arbitrary data for reasons outside of the standard Sia protocol.

ProdDependencies act as a global instance of the production dependencies to avoid having to instantiate new dependencies every time we want to pass production dependencies.

RPCDownload is the specifier for downloading a file from a host.

RPCFormContract is the specifier for forming a contract with a host.

RPCRenewContract is the specifier to renewing an existing contract.

RPCReviseContract is the specifier for revising an existing file contract.

RPCSettings is the specifier for requesting settings from the host.

SafeMutexDelay is the recommended timeout for the deadlock detecting mutex.

SectorSize defines how large a sector should be in bytes.

TransactionPoolDir is the name of the directory that is used to store the transaction pool's persistent data.

An Allowance dictates how much the Renter is allowed to spend in a given period.

ContractorSpending contains the metrics about how much the Contractor has spent during the current billing period.

ContractUtility contains metrics internal to the contractor that reflect the utility of a given contract.

DownloadInfo provides information about a file that has been requested for download.

FileInfo provides information about a file.

FileUploadParams contains the information used by the Renter to upload a file.

A HostDBEntry represents one host entry in the Renter's host DB.

HostDBScan represents a single scan event.

HostScoreBreakdown provides a piece-by-piece explanation of why a host has the score that they do.

A RenterContract contains metadata about a file contract.

RenterDownloadParameters defines the parameters passed to the Renter's Download method.

RenterPriceEstimation contains a bunch of files estimating the costs of various operations on the network.

RenterSettings control the behavior of the Renter.

BlockManager contains functions that can interface with external miners, providing and receiving blocks that have experienced nonce grinding.

CPUMiner provides access to a single-threaded cpu miner.

Dependencies defines dependencies used by all of Sia's modules.

An ErasureCoder is an error-correcting encoder and decoder.

Dependencies defines dependencies used by all of Sia's modules.

The Miner interface provides access to mining features.

A Renter uploads, tracks, repairs, and downloads a set of files for the user.

TestMiner provides direct access to block fetching, solving, and manipulation.

HostDBScans represents a sortable slice of scans.

MerkleRootSet is a set of Merkle roots, and gets encoded more efficiently.

A NetAddress contains the information needed to contact a peer.