modules

package

Go to main page

Versions in this module

v0

v0.11.5

May 13, 2024

v0.11.4

May 9, 2024

v0.11.3

May 7, 2024

Changes in this version

+ func ToString(c types.Currency) string

v0.11.2

May 5, 2024

v0.11.1

Apr 26, 2024

v0.11.0

Apr 26, 2024

Changes in this version

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

+ func DecodeV2Announcement(at types.Attestation) (na string, pk types.PublicKey, err error)

+ func DeriveRenterKey(masterKey types.PrivateKey, email string) []byte

+ func EncodedLen(txn types.Transaction) int

+ func KeyFromSeed(seed *Seed, index uint64) types.PrivateKey

+ func SeedFromPhrase(seed *Seed, phrase string) error

+ type PoolTransaction struct

+ ID types.TransactionID

+ Locked types.Currency

+ Raw types.Transaction

+ Received types.Currency

+ Sent types.Currency

+ Type string

+ type Syncer interface

+ Addr func() string

+ BroadcastHeader func(h gateway.BlockHeader)

+ BroadcastTransactionSet func(txns []types.Transaction)

+ BroadcastV2BlockOutline func(b gateway.V2BlockOutline)

+ BroadcastV2TransactionSet func(index types.ChainIndex, txns []types.V2Transaction)

+ Close func() error

+ Connect func(ctx context.Context, addr string) (*syncer.Peer, error)

+ PeerInfo func() []syncer.PeerInfo

+ Peers func() []*syncer.Peer

+ Synced func() bool

type Wallet

+ AddWatch func(addr types.Address) error

+ AddressBalance func(addr types.Address) (siacoins types.Currency, siafunds uint64)

+ Addresses func() (addrs []types.Address)

+ Annotate func(txns []types.Transaction) (ptxns []PoolTransaction)

+ Fund func(txn *types.Transaction, amount types.Currency) (parents []types.Transaction, toSign []types.Hash256, err error)

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

+ MarkWalletInputs func(txn types.Transaction) (toSign []types.Hash256)

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

+ Release func(txnSet []types.Transaction)

+ RemoveWatch func(addr types.Address) error

+ RenterSeed func(email string) []byte

+ Reserve func(ids []types.Hash256, duration time.Duration) error

+ Sign func(cs consensus.State, txn *types.Transaction, toSign []types.Hash256) error

+ Tip func() types.ChainIndex

+ UnspentSiacoinOutputs func() (sces []types.SiacoinElement)

+ UnspentSiafundOutputs func() (sfes []types.SiafundElement)

+ WatchedAddresses func() (addrs []types.Address)

v0.10.1

Feb 26, 2024

v0.10.0

Dec 26, 2023

Changes in this version

type UserBalance

+ Email string

v0.9.2

Dec 18, 2023

v0.9.1

Dec 18, 2023

v0.9.0

Dec 14, 2023

Changes in this version

type FileMetadata

+ Encrypted string

type Manager

+ AssembleParts func(types.PublicKey, types.Hash256) error

+ DeleteMultipart func(types.PublicKey, types.Hash256) error

+ DeleteMultipartUploads func(types.PublicKey) error

+ PutMultipartPart func(types.PublicKey, types.Hash256, int, string) error

+ RegisterMultipart func(types.PublicKey, types.Hash256, []byte, []byte, []byte, bool) (types.Hash256, error)

v0.8.0

Nov 18, 2023

Changes in this version

type Allowance

+ UploadPacking bool

type ContractMetadata

+ ContractPrice types.Currency

type ExtendedContract

+ ContractPrice types.Currency

type FileMetadata

+ Data []byte

type Manager

+ BufferedFilesDir func() string

+ BytesUploaded func(types.PublicKey, [255]byte, [255]byte) (string, uint64, error)

+ DeleteBufferedFile func(types.PublicKey, [255]byte, [255]byte) error

+ DeleteBufferedFiles func(types.PublicKey) error

+ GetBufferSize func() (uint64, error)

+ GetModifiedSlabs func(types.PublicKey) ([]Slab, error)

+ RegisterUpload func(types.PublicKey, [255]byte, [255]byte, [255]byte, string, bool) error

type Pricing

+ StorePartialData Price

type RenterContract

+ Unlocked bool

type RenterSettings

+ ProxyUploads bool

type Slab

+ Partial bool

type UserSpendings

+ Formed uint64

+ Locked float64

+ Overhead float64

+ Renewed uint64

+ SlabsMigrated uint64

+ SlabsRetrieved uint64

+ SlabsSaved uint64

+ Used float64

v0.7.0

Oct 23, 2023

Changes in this version

+ type BucketFiles struct

+ Name string

+ Paths []string

+ func (bf *BucketFiles) DecodeFrom(d *types.Decoder)

+ func (bf *BucketFiles) EncodeTo(e *types.Encoder)

type FileMetadata

+ Bucket string

+ ETag string

+ MimeType string

type Manager

+ Maintenance func() bool

+ StartMaintenance func(bool) error

type Portal

+ GetAnnouncement func() (string, uint64, error)

+ SetAnnouncement func(string, uint64) error

v0.6.0

Oct 17, 2023

Changes in this version

+ const OnHoldThreshold

+ var DefaultPricing = Pricing

type Manager

+ UpdatePrices func(prices Pricing) error

+ type Price struct

+ Invoicing float64

+ PrePayment float64

+ type Pricing struct

+ FormContract Price

+ MigrateSlab Price

+ RetrieveMetadata Price

+ SaveMetadata Price

+ StoreMetadata Price

+ var StaticPricing Pricing

type RenterContract

+ Imported bool

type UserBalance

+ Invoice string

+ IsRenter bool

+ OnHold uint64

v0.5.0

Sep 29, 2023

Changes in this version

+ const ASICHardforkFactor

+ const ASICHardforkHeight

+ const ASICHardforkTotalTime

+ const AcceptResponse

+ const AlertIDGatewayOffline

+ const AlertIDRenterAllowanceLowFunds

+ const AlertIDRenterContractRenewalError

+ const AlertIDWalletLockedDuringMaintenance

+ const BlockFrequency

+ const BlockSizeLimit

+ const BlocksPerDay

+ const BlocksPerHour

+ const BlocksPerMonth

+ const BlocksPerWeek

+ const BlocksPerYear

+ const BytesPerTerabyte

+ const DevAddrHardforkHeight

+ const EstimatedFileContractTransactionSetSize

+ const ExtremeFutureThreshold

+ const FoundationHardforkHeight

+ const FoundationSubsidyFrequency

+ const FutureThreshold

+ const InitialCoinbase

+ const MaturityDelay

+ const MaxEncodedNetAddressLength

+ const MedianTimestampWindow

+ const MinMessageSize

+ const MinimumCoinbase

+ const OakDecayDenom

+ const OakDecayNum

+ const OakHardforkBlock

+ const OakHardforkFixBlock

+ const OakHardforkTxnSizeLimit

+ const OakMaxBlockShift

+ const PublicKeysPerSeed

+ const SectorSize

+ const SegmentSize

+ const SeverityCritical

+ const SeverityError

+ const SeverityInfo

+ const SeverityUnknown

+ const SeverityWarning

+ const SiafundCount

+ const StopResponse

+ const StorageProofHardforkHeight

+ const TargetWindow

+ const TaxHardforkHeight

+ const TransactionSetSizeLimit

+ const TransactionSizeLimit

+ var ASICHardforkReplayProtectionPrefix = []byte

+ var ASICHardforkTotalTarget = Target

+ var BlockBytesPerMonthTerabyte = types.NewCurrency64(BytesPerTerabyte).Mul64(BlocksPerMonth)

+ var BootstrapPeers = []NetAddress

+ var ConsensusChangeBeginning = ConsensusChangeID

+ var ConsensusChangeRecent = ConsensusChangeID

+ var DefaultAllowance = Allowance

+ 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 ErrDoubleSpend = errors.New("transaction uses a parent object twice")

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

+ var ErrEntropyKey = errors.New("transaction tries to sign an entropy public key")

+ var ErrFileContractOutputSumViolation = errors.New("file contract has invalid output sums")

+ var ErrFileContractWindowEndViolation = errors.New("file contract window must end at least one block after it starts")

+ var ErrFileContractWindowStartViolation = errors.New("file contract window must start in the future")

+ var ErrFrivolousSignature = errors.New("transaction contains a frivolous signature")

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

+ var ErrInsufficientLen = errors.New("supplied ciphertext is not long enough to contain a nonce")

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

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

+ var ErrInvalidFoundationUpdateEncoding = errors.New("transaction contains an improperly-encoded FoundationUnlockHashUpdate")

+ var ErrInvalidPubKeyIndex = errors.New("transaction contains a signature that points to a nonexistent public key")

+ var ErrInvalidSignature = errors.New("invalid signature")

+ var ErrInvalidUnlockHashChecksum = errors.New("provided unlock hash has an invalid checksum")

+ 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 ErrMissingSignatures = errors.New("transaction has inputs with missing signatures")

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

+ var ErrNonZeroClaimStart = errors.New("transaction has a Siafund output with a non-zero Siafund claim")

+ var ErrNonZeroRevision = errors.New("new file contract has a nonzero revision number")

+ var ErrPrematureSignature = errors.New("timelock on signature has not expired")

+ var ErrPublicKeyOveruse = errors.New("public key was used multiple times while signing transaction")

+ var ErrSortedUniqueViolation = errors.New("sorted unique violation")

+ var ErrStorageProofWithOutputs = errors.New("transaction has both a storage proof and other outputs")

+ var ErrTimelockNotSatisfied = errors.New("timelock has not been met")

+ var ErrTransactionTooLarge = errors.New("transaction is too large to fit in a block")

+ var ErrUninitializedFoundationUpdate = errors.New("transaction contains an uninitialized FoundationUnlockHashUpdate")

+ var ErrUnlockHashWrongLen = errors.New("marshalled unlock hash is the wrong length")

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

+ var ErrWholeTransactionViolation = errors.New("covered fields violation")

+ var ErrZeroMinerFee = errors.New("transaction has a zero value miner fee")

+ var ErrZeroOutput = errors.New("transaction cannot have an output or payout that has zero value")

+ var ErrZeroRevision = errors.New("transaction has a file contract revision with RevisionNumber=0")

+ var FormContractFee = 0.1

+ var FoundationHardforkReplayProtectionPrefix = []byte

+ var FoundationSubsidyPerBlock = types.HastingsPerSiacoin.Mul64(30e3)

+ var GenesisBlock = types.Block

+ var GenesisID = GenesisBlock.ID()

+ var GenesisSiacoinAllocation = []types.SiacoinOutput

+ var GenesisSiafundAllocation = []types.SiafundOutput

+ var GenesisTimestamp = time.Unix(1433600000, 0)

+ var InitialFoundationFailsafeUnlockHash types.Address

+ var InitialFoundationSubsidy = types.HastingsPerSiacoin.Mul64(30e3).Mul64(BlocksPerYear)

+ var InitialFoundationUnlockHash types.Address

+ var MaxRPCPrice = types.HastingsPerSiacoin.Div64(1e6)

+ var MaxSectorAccessPrice = types.HastingsPerSiacoin.Div64(1e5)

+ var MaxTargetAdjustmentDown = big.NewRat(10, 25)

+ var MaxTargetAdjustmentUp = big.NewRat(25, 10)

+ var MigrateSlabFee = 0.01

+ var OakMaxDrop = big.NewRat(1e3, 1004)

+ var OakMaxRise = big.NewRat(1004, 1e3)

+ var PrefixFileContractIdentifier = types.NewSpecifier("FCIdentifier")

+ var PrefixHostAnnouncement = types.NewSpecifier("HostAnnouncement")

+ var PrefixNonSia = types.NewSpecifier("NonSia")

+ var RetrieveMetadataFee = 0.1

+ var RootDepth = Target

+ var RootTarget = Target

+ var SaveMetadataFee = 0.1

+ var SignatureEd25519 = types.NewSpecifier("ed25519")

+ var SignatureEntropy = types.NewSpecifier("entropy")

+ var StoreMetadataFee = 1

+ func AddContext(err error, ctx string) error

+ func CalculateCoinbase(height uint64) types.Currency

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

+ func CalculateLeaves(dataSize uint64) uint64

+ func CalculateNumSiacoins(height uint64) (total types.Currency)

+ func CalculateSubsidy(b types.Block, height uint64) types.Currency

+ func CheckGouging(a Allowance, height uint64, hs *rhpv2.HostSettings, pt *rhpv3.HostPriceTable, ...) (err error)

+ func ComposeErrors(errs ...error) error

+ func ContainsError(base, target error) bool

+ func CopyTransaction(txn types.Transaction) types.Transaction

+ func Decrypt(key WalletKey, ciphertext []byte) ([]byte, error)

+ func DeriveAccountKey(ak types.PrivateKey, hpk types.PublicKey) types.PrivateKey

+ func DeriveEphemeralKey(rsk types.PrivateKey, hpk types.PublicKey) types.PrivateKey

+ func DeriveRenterSeed(walletSeed Seed, email string) []byte

+ func EncodeBIP39Phrase(entropy Seed) string

+ func Encrypt(key WalletKey, plaintext []byte) ([]byte, error)

+ func ExplicitCoveredFields(txn types.Transaction) (cf types.CoveredFields)

+ func FilesizeUnits(size uint64) string

+ func Float64(c types.Currency) float64

+ func FromFloat(f float64) types.Currency

+ func FullCoveredFields() types.CoveredFields

+ func GenerateKeyPair(seed types.Hash256) (sk types.PrivateKey, pk types.PublicKey)

+ func IsConsensusConflict(err error) bool

+ func KeyFromPhrase(phrase string) (types.PrivateKey, error)

+ func MinimumTransactionSet(requiredTxns []types.Transaction, relatedTxns []types.Transaction) []types.Transaction

+ func MulFloat(c types.Currency, f float64) types.Currency

+ func NewSeedPhrase() string

+ func PartialSigHash(t types.Transaction, cf types.CoveredFields, height uint64) (hash types.Hash256)

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

+ func PostTax(height uint64, payout types.Currency) types.Currency

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

+ func ReadBool(d *types.Decoder) bool

+ func ReadBytes(d *types.Decoder) []byte

+ func ReadCurrency(s string) types.Currency

+ func ReadString(d *types.Decoder) string

+ func ReadUint64(d *types.Decoder) uint64

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

+ func SiacoinOutputSum(t types.Transaction) (sum types.Currency)

+ func SigHash(t types.Transaction, i int, height uint64) (hash types.Hash256)

+ func StandaloneValid(t types.Transaction, currentHeight uint64) (err error)

+ func StorageProofOutputID(fcid types.FileContractID, proofStatus bool, i int) types.SiacoinOutputID

+ func Tax(height uint64, payout types.Currency) types.Currency

+ func VerifyRangeProof(segments []byte, proof []types.Hash256, start, end int, root types.Hash256) bool

+ func VerifySegment(base []byte, hashSet []types.Hash256, numSegments, proofIndex uint64, ...) bool

+ func WholeSigHash(t types.Transaction, sig types.TransactionSignature, height uint64) (hash types.Hash256)

+ func WriteBool(b bool, e *types.Encoder)

+ func WriteBytes(b []byte, e *types.Encoder)

+ func WriteString(s string, e *types.Encoder)

+ func WriteUint64(i uint64, e *types.Encoder)

+ 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

+ 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() (crit, err, warn, info []Alert)

+ type Allowance struct

+ BlockHeightLeeway uint64

+ ExpectedDownload uint64

+ ExpectedStorage uint64

+ ExpectedUpload uint64

+ Funds types.Currency

+ Hosts uint64

+ MaxContractPrice types.Currency

+ MaxDownloadBandwidthPrice types.Currency

+ MaxRPCPrice types.Currency

+ MaxSectorAccessPrice types.Currency

+ MaxStoragePrice types.Currency

+ MaxUploadBandwidthPrice types.Currency

+ MinMaxCollateral types.Currency

+ MinShards uint64

+ Period uint64

+ RenewWindow uint64

+ TotalShards uint64

+ func (a *Allowance) DecodeFrom(d *types.Decoder)

+ func (a *Allowance) EncodeTo(e *types.Encoder)

+ func (a Allowance) Active() bool

+ type ConsensusChange struct

+ AppliedBlocks []types.Block

+ AppliedDiffs []ConsensusChangeDiffs

+ BlockHeight uint64

+ ChildTarget Target

+ ID ConsensusChangeID

+ MinimumValidChildTimestamp time.Time

+ RevertedBlocks []types.Block

+ RevertedDiffs []ConsensusChangeDiffs

+ Synced bool

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

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

+ func (cc *ConsensusChange) DecodeFrom(d *types.Decoder)

+ func (cc *ConsensusChange) EncodeTo(e *types.Encoder)

+ func (cc *ConsensusChange) InitialHeight() uint64

+ type ConsensusChangeDiffs struct

+ DelayedSiacoinOutputDiffs []DelayedSiacoinOutputDiff

+ FileContractDiffs []FileContractDiff

+ SiacoinOutputDiffs []SiacoinOutputDiff

+ SiafundOutputDiffs []SiafundOutputDiff

+ SiafundPoolDiffs []SiafundPoolDiff

+ func (ccd *ConsensusChangeDiffs) DecodeFrom(d *types.Decoder)

+ func (ccd *ConsensusChangeDiffs) EncodeTo(e *types.Encoder)

+ type ConsensusChangeID types.Hash256

+ func (ccID ConsensusChangeID) String() string

+ type ConsensusConflict string

+ func NewConsensusConflict(s string) ConsensusConflict

+ func (cc ConsensusConflict) Error() string

+ type ConsensusSet interface

+ AcceptBlock func(types.Block) error

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

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

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

+ Close func() error

+ ConsensusSetSubscribe func(ConsensusSetSubscriber, ConsensusChangeID, <-chan struct{}) error

+ CurrentBlock func() types.Block

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

+ Height func() uint64

+ InCurrentPath func(types.BlockID) bool

+ MinimumValidChildTimestamp func(types.BlockID) (time.Time, bool)

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

+ Synced func() bool

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

+ Unsubscribe func(ConsensusSetSubscriber)

+ type ConsensusSetSubscriber interface

+ ProcessConsensusChange func(ConsensusChange)

+ type ContractMetadata struct

+ DownloadSpending types.Currency

+ FundAccountSpending types.Currency

+ HostKey types.PublicKey

+ ID types.FileContractID

+ RenewedFrom types.FileContractID

+ Revision types.FileContractRevision

+ StartHeight uint64

+ TotalCost types.Currency

+ UploadSpending types.Currency

+ func (cm *ContractMetadata) DecodeFrom(d *types.Decoder)

+ func (cm *ContractMetadata) EncodeTo(e *types.Encoder)

+ type ContractUtility struct

+ BadContract bool

+ GoodForRenew bool

+ GoodForUpload bool

+ LastOOSErr uint64

+ Locked bool

+ type ContractWatchStatus struct

+ Archived bool

+ ContractFound bool

+ DoubleSpendHeight uint64

+ FormationSweepHeight uint64

+ LatestRevisionFound uint64

+ StorageProofFoundAtHeight uint64

+ WindowEnd uint64

+ WindowStart uint64

+ type CreditData struct

+ Amount float64

+ Remaining uint64

+ type DelayedSiacoinOutputDiff struct

+ Direction DiffDirection

+ ID types.SiacoinOutputID

+ MaturityHeight uint64

+ SiacoinOutput types.SiacoinOutput

+ func (dsod *DelayedSiacoinOutputDiff) DecodeFrom(d *types.Decoder)

+ func (dsod *DelayedSiacoinOutputDiff) EncodeTo(e *types.Encoder)

+ type DiffDirection bool

+ const ConsensusDir

+ const DiffApply

+ const DiffRevert

+ type EncryptionManager interface

+ ChangeKey func(masterKey WalletKey, newKey WalletKey) error

+ ChangeKeyWithSeed func(seed Seed, newKey WalletKey) error

+ Encrypt func(masterKey WalletKey) (Seed, error)

+ Encrypted func() (bool, error)

+ InitFromSeed func(masterKey WalletKey, seed Seed) error

+ IsMasterKey func(masterKey WalletKey) (bool, error)

+ Lock func() error

+ Reset func() error

+ Unlock func(masterKey WalletKey) error

+ UnlockAsync func(masterKey WalletKey) <-chan error

+ Unlocked func() (bool, error)

+ type ExtendedContract struct

+ Contract rhpv2.ContractRevision

+ DownloadSpending types.Currency

+ FundAccountSpending types.Currency

+ RenewedFrom types.FileContractID

+ StartHeight uint64

+ TotalCost types.Currency

+ UploadSpending types.Currency

+ func (ec ExtendedContract) DecodeFrom(d *types.Decoder)

+ func (ec ExtendedContract) EncodeTo(e *types.Encoder)

+ type ExtendedContractSet struct

+ Contracts []ExtendedContract

+ func (ecs ExtendedContractSet) DecodeFrom(d *types.Decoder)

+ func (ecs ExtendedContractSet) EncodeTo(e *types.Encoder)

+ type FileContractDiff struct

+ Direction DiffDirection

+ FileContract types.FileContract

+ ID types.FileContractID

+ func (fcd *FileContractDiff) DecodeFrom(d *types.Decoder)

+ func (fcd *FileContractDiff) EncodeTo(e *types.Encoder)

+ type FileMetadata struct

+ Key types.Hash256

+ Path string

+ Slabs []Slab

+ func (fm *FileMetadata) DecodeFrom(d *types.Decoder)

+ func (fm *FileMetadata) EncodeTo(e *types.Encoder)

+ 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 interface

+ AddToBlocklist func(addresses []string) error

+ Address func() NetAddress

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

+ Broadcast func(name string, obj types.EncoderTo, peers []Peer)

+ Close func() error

+ Connect func(NetAddress) error

+ ConnectManual func(NetAddress) error

+ Disconnect func(NetAddress) error

+ DisconnectManual func(NetAddress) error

+ DiscoverAddress func(cancel <-chan struct{}) (net.IP, error)

+ ForwardPort func(port string) error

+ Online func() bool

+ Peers func() []Peer

+ RPC func(NetAddress, string, RPCFunc) error

+ RegisterConnectCall func(string, RPCFunc)

+ RegisterRPC func(string, RPCFunc)

+ RemoveFromBlocklist func(addresses []string) error

+ SetBlocklist func(addresses []string) error

+ UnregisterConnectCall func(string)

+ UnregisterRPC func(string)

+ type GenericAlerter struct

+ func NewAlerter(module string) *GenericAlerter

+ func (a *GenericAlerter) Alerts() (crit, err, warn, info []Alert)

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

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

+ type HostAverages struct

+ BaseRPCPrice types.Currency

+ Collateral types.Currency

+ ContractPrice types.Currency

+ DownloadBandwidthPrice types.Currency

+ Duration uint64

+ NumHosts uint64

+ SectorAccessPrice types.Currency

+ StoragePrice types.Currency

+ UploadBandwidthPrice types.Currency

+ func (ha *HostAverages) DecodeFrom(d *types.Decoder)

+ func (ha *HostAverages) EncodeTo(e *types.Encoder)

+ type HostDB interface

+ ActiveHosts func() ([]HostDBEntry, error)

+ AllHosts func() ([]HostDBEntry, error)

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

+ Close func() error

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

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

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

+ IPViolationsCheck func() (bool, error)

+ IncrementFailedInteractions func(types.PublicKey) error

+ IncrementSuccessfulInteractions func(types.PublicKey) error

+ InitialScanComplete func() (bool, uint64, error)

+ LoadingComplete func() bool

+ RandomHosts func(int, []types.PublicKey, []types.PublicKey) ([]HostDBEntry, error)

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

+ ScoreBreakdown func(HostDBEntry) (HostScoreBreakdown, error)

+ SetAllowance func(Allowance) error

+ SetFilterMode func(FilterMode, []types.PublicKey, []string) error

+ SetIPViolationCheck func(enabled bool) error

+ UpdateContracts func([]RenterContract) error

+ type HostDBEntry struct

+ Filtered bool

+ FirstSeen uint64

+ HistoricDowntime time.Duration

+ HistoricFailedInteractions float64

+ HistoricSuccessfulInteractions float64

+ HistoricUptime time.Duration

+ IPNets []string

+ LastAnnouncement uint64

+ LastHistoricUpdate uint64

+ LastIPNetChange time.Time

+ PriceTable rhpv3.HostPriceTable

+ PublicKey types.PublicKey

+ RecentFailedInteractions float64

+ RecentSuccessfulInteractions float64

+ ScanHistory HostDBScans

+ Settings rhpv2.HostSettings

+ 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 HostScoreBreakdown struct

+ Age float64

+ Collateral float64

+ Interactions float64

+ Prices float64

+ Score types.Currency

+ StorageRemaining float64

+ Uptime float64

+ Version float64

+ type KeyManager interface

+ AllAddresses func() ([]types.Address, error)

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

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

+ LoadSeed func(WalletKey, Seed) error

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

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

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

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

+ SignTransaction func(txn *types.Transaction, toSign []types.Hash256, cf types.CoveredFields) error

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

+ 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 Manager interface

+ AcceptContracts func(types.PublicKey, []ContractMetadata)

+ ActiveHosts func() ([]HostDBEntry, error)

+ AllHosts func() ([]HostDBEntry, error)

+ BlockHeight func() uint64

+ Close func() error

+ Contracts func() []RenterContract

+ ContractsByRenter func(types.PublicKey) []RenterContract

+ CreateNewRenter func(string, types.PublicKey)

+ DeleteMetadata func(types.PublicKey)

+ DeleteObject func(types.PublicKey, string) error

+ DeleteRenter func(string)

+ DownloadObject func(io.Writer, types.PublicKey, string) error

+ FeeEstimation func() (min, max types.Currency)

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

+ FormContract func(*RPCSession, types.PublicKey, types.PublicKey, types.PublicKey, uint64, uint64, ...) (RenterContract, error)

+ FormContracts func(types.PublicKey, types.PrivateKey, Allowance) ([]RenterContract, error)

+ GetAverages func() HostAverages

+ GetBalance func(string) (UserBalance, error)

+ GetEmailPreferences func() (string, types.Currency)

+ GetExchangeRate func(string) (float64, error)

+ GetRenter func(types.PublicKey) (Renter, error)

+ GetSiacoinRate func(string) (float64, error)

+ GetSpendings func(string) (UserSpendings, error)

+ GetWalletSeed func() (Seed, error)

+ Host func(types.PublicKey) (HostDBEntry, bool, error)

+ IncrementStats func(string, bool) error

+ InitialScanComplete func() (bool, uint64, error)

+ LockSiacoins func(string, float64) error

+ OldContracts func() []RenterContract

+ OldContractsByRenter func(types.PublicKey) []RenterContract

+ RandomHosts func(uint64, Allowance) ([]HostDBEntry, error)

+ RefreshedContract func(types.FileContractID) bool

+ RenewContract func(*RPCSession, types.PublicKey, types.FileContractID, uint64, uint64, uint64, ...) (RenterContract, error)

+ RenewContracts func(types.PublicKey, types.PrivateKey, Allowance, []types.FileContractID) ([]RenterContract, error)

+ RenewedFrom func(types.FileContractID) types.FileContractID

+ Renters func() []Renter

+ RetrieveMetadata func(types.PublicKey, []string) ([]FileMetadata, error)

+ RetrieveSpendings func(string, string) (UserSpendings, error)

+ ScoreBreakdown func(HostDBEntry) (HostScoreBreakdown, error)

+ SetAllowance func(types.PublicKey, Allowance) error

+ SetEmailPreferences func(string, types.Currency) error

+ SetFilterMode func(FilterMode, []types.PublicKey, []string) error

+ UnlockSiacoins func(string, float64, float64, uint64) error

+ UpdateBalance func(email string, ub UserBalance) error

+ UpdateContract func(types.FileContractRevision, []types.TransactionSignature, types.Currency, ...) error

+ UpdateMetadata func(types.PublicKey, FileMetadata) error

+ UpdateRenterSettings func(types.PublicKey, RenterSettings, types.PrivateKey, types.PrivateKey) error

+ UpdateSlab func(types.PublicKey, Slab) error

+ UpdateSpendings func(string, UserSpendings) error

+ type MerkleTree struct

+ func NewTree() *MerkleTree

+ func (t *MerkleTree) PushObject(obj types.EncoderTo)

+ func (t *MerkleTree) Root() (h types.Hash256)

+ type NetAddress string

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

+ func (na NetAddress) Host() string

+ func (na NetAddress) IsLocal() bool

+ func (na NetAddress) IsLoopback() bool

+ func (na NetAddress) IsStdValid() error

+ func (na NetAddress) IsValid() error

+ func (na NetAddress) Port() string

+ type Peer struct

+ Inbound bool

+ Local bool

+ NetAddress NetAddress

+ Version string

+ type PeerConn interface

+ RPCAddr func() NetAddress

+ type Portal interface

+ Close func() error

+ GetCredits func() CreditData

+ SetCredits func(CreditData)

+ type ProcessedInput struct

+ FundType types.Specifier

+ ParentID types.Hash256

+ RelatedAddress types.Address

+ Value types.Currency

+ WalletAddress bool

+ func (pi *ProcessedInput) DecodeFrom(d *types.Decoder)

+ func (pi *ProcessedInput) EncodeTo(e *types.Encoder)

+ type ProcessedOutput struct

+ FundType types.Specifier

+ ID types.Hash256

+ MaturityHeight uint64

+ RelatedAddress types.Address

+ Value types.Currency

+ WalletAddress bool

+ func (po *ProcessedOutput) DecodeFrom(d *types.Decoder)

+ func (po *ProcessedOutput) EncodeTo(e *types.Encoder)

+ type ProcessedTransaction struct

+ ConfirmationHeight uint64

+ ConfirmationTimestamp time.Time

+ Inputs []ProcessedInput

+ Outputs []ProcessedOutput

+ Transaction types.Transaction

+ TransactionID types.TransactionID

+ func (pt *ProcessedTransaction) DecodeFrom(d *types.Decoder)

+ func (pt *ProcessedTransaction) EncodeTo(e *types.Encoder)

+ type Provider interface

+ Close func() error

+ PublicKey func() types.PublicKey

+ SecretKey func() types.PrivateKey

+ type RPCError struct

+ Data []byte

+ Description string

+ Type types.Specifier

+ func (e *RPCError) Error() string

+ func (re *RPCError) DecodeFrom(d *types.Decoder)

+ func (re *RPCError) EncodeTo(e *types.Encoder)

+ type RPCFunc func(PeerConn) error

+ type RPCResponse struct

+ func (resp *RPCResponse) DecodeFrom(d *types.Decoder)

+ func (resp *RPCResponse) EncodeTo(e *types.Encoder)

+ type RPCSession struct

+ Aead cipher.AEAD

+ Challenge [16]byte

+ Conn net.Conn

+ func (s *RPCSession) ReadMessage(message RequestBody, maxLen uint64) error

+ func (s *RPCSession) ReadRequest(req RequestBody, maxLen uint64) (types.Hash256, error)

+ func (s *RPCSession) ReadResponse(resp RequestBody, maxLen uint64) error

+ func (s *RPCSession) WriteError(err error) error

+ func (s *RPCSession) WriteMessage(message RequestBody) error

+ func (s *RPCSession) WriteResponse(resp RequestBody) error

+ type Renter struct

+ AccountKey types.PrivateKey

+ Allowance Allowance

+ CurrentPeriod uint64

+ Email string

+ PrivateKey types.PrivateKey

+ PublicKey types.PublicKey

+ Settings RenterSettings

+ func (r *Renter) ContractEndHeight() uint64

+ type RenterContract struct

+ ContractFee types.Currency

+ DownloadSpending types.Currency

+ EndHeight uint64

+ FundAccountSpending types.Currency

+ HostPublicKey types.PublicKey

+ ID types.FileContractID

+ MaintenanceSpending MaintenanceSpending

+ RenterFunds types.Currency

+ RenterPublicKey types.PublicKey

+ SiafundFee types.Currency

+ StartHeight uint64

+ StorageSpending types.Currency

+ TotalCost types.Currency

+ Transaction types.Transaction

+ TxnFee types.Currency

+ UploadSpending types.Currency

+ Utility ContractUtility

+ func (rc *RenterContract) Size() uint64

+ type RenterSettings struct

+ AutoRenewContracts bool

+ AutoRepairFiles bool

+ BackupFileMetadata bool

+ type RenterSpending struct

+ ContractFees types.Currency

+ DownloadSpending types.Currency

+ FundAccountSpending types.Currency

+ MaintenanceSpending MaintenanceSpending

+ PreviousSpending types.Currency

+ ReleaseBlock uint64

+ StorageSpending types.Currency

+ TotalAllocated types.Currency

+ Unspent types.Currency

+ UploadSpending types.Currency

+ WithheldFunds types.Currency

+ func (rs RenterSpending) SpendingBreakdown() (totalSpent, unspentAllocated, unspentUnallocated types.Currency)

+ type RequestBody interface

+ DecodeFrom func(d *types.Decoder)

+ EncodeTo func(e *types.Encoder)

+ type Seed [16]byte

+ func DecodeBIP39Phrase(phrase string) (Seed, error)

+ type Shard struct

+ Host types.PublicKey

+ Root types.Hash256

+ func (ss *Shard) DecodeFrom(d *types.Decoder)

+ func (ss *Shard) EncodeTo(e *types.Encoder)

+ type SiacoinOutputDiff struct

+ Direction DiffDirection

+ ID types.SiacoinOutputID

+ SiacoinOutput types.SiacoinOutput

+ func (sod *SiacoinOutputDiff) DecodeFrom(d *types.Decoder)

+ func (sod *SiacoinOutputDiff) EncodeTo(e *types.Encoder)

+ type SiacoinSenderMulti interface

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

+ type SiafundOutputDiff struct

+ ClaimStart types.Currency

+ Direction DiffDirection

+ ID types.SiafundOutputID

+ SiafundOutput types.SiafundOutput

+ func (sfd *SiafundOutputDiff) DecodeFrom(d *types.Decoder)

+ func (sfd *SiafundOutputDiff) EncodeTo(e *types.Encoder)

+ type SiafundPoolDiff struct

+ Adjusted types.Currency

+ Direction DiffDirection

+ Previous types.Currency

+ func (spd *SiafundPoolDiff) DecodeFrom(d *types.Decoder)

+ func (spd *SiafundPoolDiff) EncodeTo(e *types.Encoder)

+ type Slab struct

+ Key types.Hash256

+ Length uint64

+ MinShards uint8

+ Offset uint64

+ Shards []Shard

+ func (s *Slab) DecodeFrom(d *types.Decoder)

+ func (s *Slab) EncodeTo(e *types.Encoder)

+ type SpendingDetails struct

+ DownloadSpending types.Currency

+ FundAccountSpending types.Currency

+ MaintenanceSpending MaintenanceSpending

+ StorageSpending types.Currency

+ UploadSpending types.Currency

+ type Target types.Hash256

+ func IntToTarget(i *big.Int) (t Target)

+ func RatToTarget(r *big.Rat) (t Target)

+ func (x Target) AddDifficulties(y Target) (t Target)

+ func (x Target) Cmp(y Target) int

+ func (x Target) Difficulty() types.Currency

+ func (x Target) Int() *big.Int

+ func (x Target) Inverse() *big.Rat

+ func (x Target) MulDifficulty(y *big.Rat) (t Target)

+ func (x Target) Rat() *big.Rat

+ func (x Target) SubtractDifficulties(y Target) (t Target)

+ type TransactionBuilder interface

+ FundTransaction func(txn *types.Transaction, amount types.Currency) (types.Transaction, []types.Hash256, error)

+ MarkWalletInputs func(txn types.Transaction) []types.Hash256

+ ReleaseInputs func(txnSet []types.Transaction)

+ Sign func(txn *types.Transaction, toSign []types.Hash256, cf types.CoveredFields) error

+ type TransactionPool interface

+ AcceptTransactionSet func([]types.Transaction) error

+ Broadcast func(ts []types.Transaction)

+ Close func() error

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

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

+ TransactionConfirmed func(id types.TransactionID) (bool, error)

+ TransactionList func() []types.Transaction

+ TransactionPoolSubscribe func(TransactionPoolSubscriber)

+ TransactionSet func(types.Hash256) []types.Transaction

+ Transactions func() []types.Transaction

+ Unsubscribe func(TransactionPoolSubscriber)

+ type TransactionPoolDiff struct

+ AppliedTransactions []*UnconfirmedTransactionSet

+ RevertedTransactions []TransactionSetID

+ type TransactionPoolSubscriber interface

+ ReceiveUpdatedUnconfirmedTransactions func(*TransactionPoolDiff)

+ type TransactionSetID types.Hash256

+ type UnconfirmedTransactionSet struct

+ Change *ConsensusChange

+ ID TransactionSetID

+ IDs []types.TransactionID

+ Sizes []uint64

+ Transactions []types.Transaction

+ type UnspentOutput struct

+ ConfirmationHeight uint64

+ FundType types.Specifier

+ ID types.Hash256

+ IsWatchOnly bool

+ UnlockHash types.Address

+ Value types.Currency

+ type UserBalance struct

+ Balance float64

+ Currency string

+ IsUser bool

+ Locked float64

+ SCRate float64

+ StripeID string

+ Subscribed bool

+ type UserSpendings struct

+ CurrentFormed uint64

+ CurrentLocked float64

+ CurrentOverhead float64

+ CurrentRenewed uint64

+ CurrentSlabsMigrated uint64

+ CurrentSlabsRetrieved uint64

+ CurrentSlabsSaved uint64

+ CurrentUsed float64

+ PrevFormed uint64

+ PrevLocked float64

+ PrevOverhead float64

+ PrevRenewed uint64

+ PrevSlabsMigrated uint64

+ PrevSlabsRetrieved uint64

+ PrevSlabsSaved uint64

+ PrevUsed float64

+ SCRate float64

+ type ValuedTransaction struct

+ ConfirmedIncomingValue types.Currency

+ ConfirmedOutgoingValue types.Currency

+ type Wallet interface

+ AddUnlockConditions func(uc types.UnlockConditions) error

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

+ AddressTransactions func(types.Address) ([]ProcessedTransaction, error)

+ AddressUnconfirmedTransactions func(types.Address) ([]ProcessedTransaction, error)

+ Close func() error

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

+ DustThreshold func() (types.Currency, error)

+ Height func() (uint64, error)

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

+ Rescanning func() (bool, error)

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

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

+ SetSettings func(WalletSettings) error

+ Settings func() (WalletSettings, error)

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

+ Transactions func(startHeight uint64, endHeight uint64) ([]ProcessedTransaction, error)

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

+ UnconfirmedTransactions func() ([]ProcessedTransaction, error)

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

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

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

+ type WalletKey []byte

+ type WalletSettings struct

+ NoDefrag bool

+ type WalletTransactionID types.Hash256

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

v0.4.0-beta

Sep 10, 2023

v0.3.2-beta

Aug 5, 2023

v0.3.1-beta

Aug 3, 2023

v0.3.0-beta

Jul 31, 2023

v0.2.0-beta

May 18, 2023

v0.1.0-beta

Apr 23, 2023

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL