api

package

Go to main page

Versions in this module

v1

v1.1.1

Dec 17, 2024

v1.1.1-alpha.1

Dec 17, 2024

v1.1.0

Nov 19, 2024

Changes in this version

+ const EventAdd

+ const ModuleHost

+ var DefaultGougingSettings = GougingSettings

+ var DefaultPricePinSettings = PricePinSettings

+ var DefaultRedundancySettings = RedundancySettings

+ var DefaultRedundancySettingsTestnet = RedundancySettings

+ var DefaultUploadPackingSettings = UploadPackingSettings

+ var WebhookContractAdd = func(url string, headers map[string]string) webhooks.Webhook

+ var WebhookHostUpdate = func(url string, headers map[string]string) webhooks.Webhook

type Account

+ Owner string

+ type AccountsFundRequest struct

+ AccountID rhpv3.Account

+ Amount types.Currency

+ ContractID types.FileContractID

+ type AccountsFundResponse struct

+ Deposit types.Currency

+ type AccountsSaveRequest struct

+ Accounts []Account

type ArchivedContract

+ ArchivalReason string

+ ContractPrice types.Currency

+ HostIP string

+ RenewedFrom types.FileContractID

+ TotalCost types.Currency

type BusStateResponse

+ Network string

+ type ContractFormRequest struct

+ EndHeight uint64

+ HostCollateral types.Currency

+ HostIP string

+ HostKey types.PublicKey

+ RenterAddress types.Address

+ RenterFunds types.Currency

type ContractMetadata

+ func (cm ContractMetadata) InSet(set string) bool

+ type ContractPruneRequest struct

+ Timeout DurationMS

+ type ContractPruneResponse struct

+ ContractSize uint64

+ Error string

+ Pruned uint64

+ Remaining uint64

+ type ContractRenewRequest struct

+ EndHeight uint64

+ ExpectedNewStorage uint64

+ MaxFundAmount types.Currency

+ MinNewCollateral types.Currency

+ RenterFunds types.Currency

+ type ContractSetUpdateRequest struct

+ ToAdd []types.FileContractID

+ ToRemove []types.FileContractID

type ContractSpending

+ func (x ContractSpending) Total() types.Currency

+ type ContractState string

type ContractsConfig

+ func (c ContractsConfig) SortContractsForMaintenance(contracts []Contract)

+ type EventContractAdd struct

+ Added ContractMetadata

+ Timestamp time.Time

type EventContractSetUpdate

+ ToAdd []types.FileContractID

+ ToRemove []types.FileContractID

+ type EventHostUpdate struct

+ HostKey types.PublicKey

+ NetAddr string

+ Timestamp time.Time

type Host

+ ResolvedAddresses []string

type HostScan

+ ResolvedAddresses []string

type HostsConfig

+ MaxConsecutiveScanFailures uint64

type HostsRemoveRequest

+ MaxConsecutiveScanFailures uint64

type RHPScanResponse

+ func (r RHPScanResponse) Error() error

+ type SiacoinElement struct

+ ID types.SiacoinOutputID

+ MaturityHeight uint64

+ type Transaction struct

+ ID types.TransactionID

+ Index types.ChainIndex

+ Inflow types.Currency

+ Outflow types.Currency

+ Raw types.Transaction

+ Timestamp time.Time

type WalletMetric

+ Immature types.Currency

type WalletResponse

+ Immature types.Currency

+ type WalletSendRequest struct

+ Address types.Address

+ Amount types.Currency

+ SubtractMinerFee bool

+ UseUnconfirmed bool

v1.1.0-beta.6

Nov 19, 2024

v1.1.0-beta.5

Oct 2, 2024

v1.1.0-beta.4

Sep 19, 2024

v1.1.0-beta.3

Sep 16, 2024

v1.1.0-beta.2

Aug 28, 2024

v1.1.0-beta.1

Aug 26, 2024

v1.0.8

Jul 3, 2024

Changes in this version

+ const EventArchive

+ const EventDelete

+ const EventRenew

+ const EventUpdate

+ const ModuleConsensus

+ const ModuleContract

+ const ModuleContractSet

+ const ModuleSetting

+ const SettingPricePinning

+ var ErrHostTooManyAddresses = errors.New("host has more than two addresses, or two of the same type")

+ var ErrMarkerNotFound = errors.New("marker not found")

+ var ErrMaxFundAmountExceeded = errors.New("renewal exceeds max fund amount")

+ var ErrUnknownEvent = errors.New("unknown event")

+ var WebhookConsensusUpdate = func(url string, headers map[string]string) webhooks.Webhook

+ var WebhookContractArchive = func(url string, headers map[string]string) webhooks.Webhook

+ var WebhookContractRenew = func(url string, headers map[string]string) webhooks.Webhook

+ var WebhookContractSetUpdate = func(url string, headers map[string]string) webhooks.Webhook

+ var WebhookSettingDelete = func(url string, headers map[string]string) webhooks.Webhook

+ var WebhookSettingUpdate = func(url string, headers map[string]string) webhooks.Webhook

+ func ParseEventWebhook(event webhooks.Event) (interface{}, error)

+ type AutopilotPins struct

+ Allowance Pin

+ type EventConsensusUpdate struct

+ Timestamp time.Time

+ TransactionFee types.Currency

+ type EventContractArchive struct

+ ContractID types.FileContractID

+ Reason string

+ Timestamp time.Time

+ type EventContractRenew struct

+ Renewal ContractMetadata

+ Timestamp time.Time

+ type EventContractSetUpdate struct

+ ContractIDs []types.FileContractID

+ Name string

+ Timestamp time.Time

+ type EventSettingDelete struct

+ Key string

+ Timestamp time.Time

+ type EventSettingUpdate struct

+ Key string

+ Timestamp time.Time

+ Update interface{}

+ type GougingSettingsPins struct

+ MaxDownload Pin

+ MaxRPCPrice Pin

+ MaxStorage Pin

+ MaxUpload Pin

type Host

+ Subnets []string

type HostScan

+ Subnets []string

type ListObjectOptions

+ SortBy string

+ SortDir string

+ type Pin struct

+ Pinned bool

+ Value float64

+ func (p Pin) IsPinned() bool

+ type PricePinSettings struct

+ Autopilots map[string]AutopilotPins

+ Currency string

+ Enabled bool

+ ForexEndpointURL string

+ GougingSettingsPins GougingSettingsPins

+ Threshold float64

+ func (pps PricePinSettings) Validate() error

type RHPRenewRequest

+ MaxFundAmount types.Currency

type RHPRenewResponse

+ FundAmount types.Currency

type WalletPrepareRenewRequest

+ MaxFundAmount types.Currency

type WalletPrepareRenewResponse

+ FundAmount types.Currency

+ type WebhookResponse struct

+ Queues []webhooks.WebhookQueueInfo

+ Webhooks []webhooks.Webhook

v1.0.8-beta.2

Jul 3, 2024

v1.0.8-beta.1

Jun 28, 2024

v1.0.7

Apr 24, 2024

Changes in this version

+ var ErrInvalidMultipartEncryptionSettings = errors.New("invalid multipart encryption settings")

+ var ErrInvalidRedundancySettings = errors.New("invalid redundancy settings")

+ var ErrMultiRangeNotSupported = errors.New("multipart ranges are not supported")

+ var ErrUsabilityHostBlocked = errors.New("host is blocked")

+ var ErrUsabilityHostLowScore = errors.New("host's score is below minimum")

+ var ErrUsabilityHostNotAcceptingContracts = errors.New("host is not accepting contracts")

+ var ErrUsabilityHostNotAnnounced = errors.New("host is not announced")

+ var ErrUsabilityHostNotCompletingScan = errors.New("host is not completing scan")

+ var ErrUsabilityHostNotFound = errors.New("host not found")

+ var ErrUsabilityHostOffline = errors.New("host is offline")

+ var ErrUsabilityHostPriceGouging = errors.New("host is price gouging")

+ var ErrUsabilityHostRedundantIP = errors.New("host has redundant IP")

type Autopilot

+ func (ap *Autopilot) EndHeight() uint64

+ type CompleteMultipartOptions struct

+ Metadata ObjectUserMetadata

+ type ContentRange struct

+ Length int64

+ Offset int64

+ Size int64

+ func ParseContentRange(contentRange string) (ContentRange, error)

type ContractsResponse

+ Errors map[types.PublicKey]string

type DownloadRange

+ func (r *DownloadRange) ContentRange(size int64) *ContentRange

type HeadObjectOptions

+ IgnoreDelim bool

+ func (opts HeadObjectOptions) Apply(values url.Values)

type HeadObjectResponse

+ Etag string

+ type Host struct

+ Blocked bool

+ Checks map[string]HostCheck

+ Interactions HostInteractions

+ KnownSince time.Time

+ LastAnnouncement time.Time

+ NetAddress string

+ PriceTable HostPriceTable

+ PublicKey types.PublicKey

+ Scanned bool

+ Settings rhpv2.HostSettings

+ StoredData uint64

+ func (h Host) IsAnnounced() bool

+ func (h Host) IsOnline() bool

+ type HostAddress struct

+ NetAddress string

+ PublicKey types.PublicKey

+ type HostCheck struct

+ Gouging HostGougingBreakdown

+ Score HostScoreBreakdown

+ Usability HostUsabilityBreakdown

+ type HostChecks struct

+ Gouging bool

+ GougingBreakdown HostGougingBreakdown

+ Score float64

+ ScoreBreakdown HostScoreBreakdown

+ UnusableReasons []string

+ Usable bool

+ type HostInteractions struct

+ Downtime time.Duration

+ FailedInteractions float64

+ LastScan time.Time

+ LastScanSuccess bool

+ LostSectors uint64

+ SecondToLastScanSuccess bool

+ SuccessfulInteractions float64

+ TotalScans uint64

+ Uptime time.Duration

+ type HostPriceTable struct

+ Expiry time.Time

+ type HostPriceTableUpdate struct

+ HostKey types.PublicKey

+ PriceTable HostPriceTable

+ Success bool

+ Timestamp time.Time

+ type HostResponse struct

+ Checks *HostChecks

+ Host Host

+ type HostScan struct

+ HostKey types.PublicKey

+ PriceTable rhpv3.HostPriceTable

+ Settings rhpv2.HostSettings

+ Success bool

+ Timestamp time.Time

+ type HostUsabilityBreakdown struct

+ Blocked bool

+ Gouging bool

+ LowScore bool

+ NotAcceptingContracts bool

+ NotAnnounced bool

+ NotCompletingScan bool

+ Offline bool

+ RedundantIP bool

+ func (ub HostUsabilityBreakdown) IsUsable() bool

+ func (ub HostUsabilityBreakdown) UnusableReasons() []string

type HostsConfig

+ MinProtocolVersion string

type MultipartCompleteRequest

+ Metadata ObjectUserMetadata

type SearchHostOptions

+ AutopilotID string

+ UsabilityMode string

type SearchHostsRequest

+ AutopilotID string

type UploadMultipartUploadPartOptions

+ ContractSet string

+ MinShards int

+ TotalShards int

v1.0.7-beta.3

Apr 24, 2024

v1.0.7-beta.2

Apr 23, 2024

v1.0.7-beta.1

Apr 22, 2024

v1.0.6

Mar 12, 2024

Changes in this version

+ var ErrHostOnPrivateNetwork = errors.New("host is on a private network")

+ type ConfigEvaluationRequest struct

+ AutopilotConfig AutopilotConfig

+ GougingSettings GougingSettings

+ RedundancySettings RedundancySettings

+ type ConfigEvaluationResponse struct

+ Hosts uint64

+ Recommendation *ConfigRecommendation

+ Unusable struct{ ... }

+ Usable uint64

+ type ConfigRecommendation struct

+ GougingSettings GougingSettings

type CreateMultipartOptions

+ GenerateKey bool

type GetObjectOptions

+ OnlyMetadata bool

+ type HeadObjectOptions struct

+ Range DownloadRange

+ func (opts HeadObjectOptions) ApplyHeaders(h http.Header)

+ type HeadObjectResponse struct

+ ContentType string

+ LastModified string

+ Metadata ObjectUserMetadata

+ Range *DownloadRange

+ Size int64

type MultipartCreateRequest

+ GenerateKey bool

+ type ObjectsStatsOpts struct

+ Bucket string

type RedundancySettings

+ func (rs RedundancySettings) SlabSize() uint64

v1.0.6-beta.1

Mar 12, 2024

v1.0.5

Feb 14, 2024

v1.0.4

Feb 12, 2024

v1.0.3

Feb 6, 2024

Changes in this version

+ const MetricMaxIntervals

+ const ObjectMetadataPrefix

+ var ErrMaxIntervalsExceeded = fmt.Errorf("max number of intervals exceeds maximum of %v", MetricMaxIntervals)

+ var ErrSlabNotFound = errors.New("slab not found")

type AddObjectOptions

+ Metadata ObjectUserMetadata

+ type AddObjectRequest struct

+ Bucket string

+ ContractSet string

+ ETag string

+ Metadata ObjectUserMetadata

+ MimeType string

+ Object object.Object

type CopyObjectOptions

+ Metadata ObjectUserMetadata

+ type CopyObjectsRequest struct

+ DestinationBucket string

+ DestinationPath string

+ Metadata ObjectUserMetadata

+ MimeType string

+ SourceBucket string

+ SourcePath string

type CreateMultipartOptions

+ Metadata ObjectUserMetadata

type GetObjectResponse

+ LastModified string

+ Metadata ObjectUserMetadata

type MultipartCreateRequest

+ Metadata ObjectUserMetadata

type Object

+ Metadata ObjectUserMetadata

+ type ObjectUserMetadata map[string]string

+ func ExtractObjectUserMetadataFrom(metadata map[string]string) ObjectUserMetadata

type UploadObjectOptions

+ Metadata ObjectUserMetadata

+ func (opts UploadObjectOptions) ApplyHeaders(h http.Header)

+ func (opts UploadObjectOptions) ApplyValues(values url.Values)

v1.0.2

Jan 19, 2024

v1.0.1

Jan 10, 2024

Changes in this version

+ const ObjectSortBySize

type GetObjectOptions

+ SortBy string

+ SortDir string

v1.0.0

Dec 21, 2023

v0

v0.7.2

Dec 21, 2023

Changes in this version

type ContractMetadata

+ ContractSets []string

+ type ContractsOpts struct

+ ContractSet string

type ObjectsStatsResponse

+ NumUnfinishedObjects uint64

+ TotalUnfinishedObjectsSize uint64

v0.7.1

Dec 15, 2023

v0.7.0

Dec 13, 2023

Changes in this version

+ const ChurnDirAdded

+ const ChurnDirRemoved

+ const ContractStateActive

+ const ContractStateComplete

+ const ContractStateFailed

+ const ContractStateInvalid

+ const ContractStatePending

+ const ContractStateUnknown

+ const MetricContract

+ const MetricContractPrune

+ const MetricContractSet

+ const MetricContractSetChurn

+ const MetricPerformance

+ const MetricWallet

+ const ObjectSortByHealth

+ const ObjectSortByName

+ const ObjectSortDirAsc

+ const ObjectSortDirDesc

+ const S3MaxAccessKeyLen

+ const S3MinAccessKeyLen

+ const S3SecretKeyLen

+ var ErrInvalidObjectSortParameters = errors.New("invalid sort parameters")

+ var ErrObjectExists = errors.New("object already exists")

+ func CompareTimeRFC3339(t1, t2 TimeRFC3339) bool

+ func ObjectPathEscape(path string) string

+ type AddObjectOptions struct

+ ETag string

+ MimeType string

type ArchivedContract

+ State string

type AutopilotStateResponse

+ Pruning bool

+ PruningLastStart TimeRFC3339

+ type ContractAddRequest struct

+ Contract rhpv2.ContractRevision

+ ContractPrice types.Currency

+ StartHeight uint64

+ State string

+ TotalCost types.Currency

type ContractMetadata

+ ContractPrice types.Currency

+ State string

+ type ContractMetric struct

+ ContractID types.FileContractID

+ DeleteSpending types.Currency

+ DownloadSpending types.Currency

+ FundAccountSpending types.Currency

+ HostKey types.PublicKey

+ ListSpending types.Currency

+ RemainingCollateral types.Currency

+ RemainingFunds types.Currency

+ RevisionNumber uint64

+ Timestamp TimeRFC3339

+ UploadSpending types.Currency

+ type ContractMetricRequestPUT struct

+ Metrics []ContractMetric

+ type ContractMetricsQueryOpts struct

+ ContractID types.FileContractID

+ HostKey types.PublicKey

+ type ContractPruneMetric struct

+ ContractID types.FileContractID

+ Duration time.Duration

+ HostKey types.PublicKey

+ HostVersion string

+ Pruned uint64

+ Remaining uint64

+ Timestamp time.Time

+ type ContractPruneMetricRequestPUT struct

+ Metrics []ContractPruneMetric

+ type ContractPruneMetricsQueryOpts struct

+ ContractID types.FileContractID

+ HostKey types.PublicKey

+ HostVersion string

+ type ContractRenewedRequest struct

+ Contract rhpv2.ContractRevision

+ ContractPrice types.Currency

+ RenewedFrom types.FileContractID

+ StartHeight uint64

+ State string

+ TotalCost types.Currency

+ type ContractSetChurnMetric struct

+ ContractID types.FileContractID

+ Direction string

+ Name string

+ Reason string

+ Timestamp TimeRFC3339

+ type ContractSetChurnMetricRequestPUT struct

+ Metrics []ContractSetChurnMetric

+ type ContractSetChurnMetricsQueryOpts struct

+ Direction string

+ Name string

+ Reason string

+ type ContractSetMetric struct

+ Contracts int

+ Name string

+ Timestamp TimeRFC3339

+ type ContractSetMetricsQueryOpts struct

+ Name string

type ContractSpendingRecord

+ MissedHostPayout types.Currency

+ ValidRenterPayout types.Currency

+ type ContractsArchiveRequest = map[types.FileContractID]string

type ContractsConfig

+ Prune bool

+ type CreateBucketOptions struct

+ Policy BucketPolicy

+ type DeleteObjectOptions struct

+ Batch bool

+ func (opts DeleteObjectOptions) Apply(values url.Values)

+ type DownloadObjectOptions struct

+ Limit int

+ Offset int

+ Prefix string

+ Range DownloadRange

+ func (opts DownloadObjectOptions) ApplyHeaders(h http.Header)

+ func (opts DownloadObjectOptions) ApplyValues(values url.Values)

type DownloadRange

+ Offset int64

+ Size int64

+ type GetHostsOptions struct

+ Limit int

+ Offset int

+ func (opts GetHostsOptions) Apply(values url.Values)

+ type GetObjectOptions struct

+ IgnoreDelim bool

+ Limit int

+ Marker string

+ Offset int

+ Prefix string

+ func (opts GetObjectOptions) Apply(values url.Values)

type GougingSettings

+ MigrationSurchargeMultiplier uint64

type HostGougingBreakdown

+ ContractErr string

+ DownloadErr string

+ GougingErr string

+ PruneErr string

+ UploadErr string

+ func (hgb HostGougingBreakdown) String() string

type HostsConfig

+ MinRecentScanFailures uint64

+ type HostsForScanningOptions struct

+ Limit int

+ MaxLastScan TimeRFC3339

+ Offset int

+ func (opts HostsForScanningOptions) Apply(values url.Values)

+ type ListObjectOptions struct

+ Limit int

+ Marker string

+ Prefix string

+ type MemoryResponse struct

+ Download MemoryStatus

+ Upload MemoryStatus

+ type MemoryStatus struct

+ Available uint64

+ Total uint64

type MigrateSlabResponse

+ Error string

+ SurchargeApplied bool

+ type ObjectEntriesOptions struct

+ Limit int

+ Offset int

+ Prefix string

type ObjectsListRequest

+ SortBy string

+ SortDir string

type ObjectsRenameRequest

+ Force bool

type ObjectsStatsResponse

+ MinHealth float64

+ type PerformanceMetric struct

+ Action string

+ Duration time.Duration

+ HostKey types.PublicKey

+ Origin string

+ Timestamp TimeRFC3339

+ type PerformanceMetricsQueryOpts struct

+ Action string

+ HostKey types.PublicKey

+ Origin string

type RHPPruneContractResponse

+ Error string

type RHPRenewRequest

+ ExpectedNewStorage uint64

+ MinNewCollateral types.Currency

type RHPRenewResponse

+ ContractPrice types.Currency

type RedundancySettings

+ func (rs RedundancySettings) SlabSizeNoRedundancy() uint64

type S3AuthenticationSettings

+ func (s3as S3AuthenticationSettings) Validate() error

+ type SearchHostOptions struct

+ AddressContains string

+ FilterMode string

+ KeyIn []types.PublicKey

+ Limit int

+ Offset int

+ func DefaultSearchHostOptions() SearchHostOptions

+ type SearchObjectOptions struct

+ Key string

+ Limit int

+ Offset int

+ func (opts SearchObjectOptions) Apply(values url.Values)

type TimeRFC3339

+ func TimeNow() TimeRFC3339

+ func (t TimeRFC3339) IsZero() bool

+ func (t TimeRFC3339) Std() time.Time

+ type UploadMultipartUploadPartOptions struct

+ ContentLength int64

+ DisablePreshardingEncryption bool

+ EncryptionOffset int

+ func (opts UploadMultipartUploadPartOptions) Apply(values url.Values)

+ type UploadObjectOptions struct

+ ContentLength int64

+ ContractSet string

+ DisablePreshardingEncryption bool

+ MimeType string

+ MinShards int

+ Offset int

+ TotalShards int

+ func (opts UploadObjectOptions) Apply(values url.Values)

type UploadedPackedSlab

+ func (s UploadedPackedSlab) Contracts() map[types.PublicKey]map[types.FileContractID]struct{}

type WalletFundRequest

+ UseUnconfirmedTxns bool

+ type WalletMetric struct

+ Confirmed types.Currency

+ Spendable types.Currency

+ Timestamp TimeRFC3339

+ Unconfirmed types.Currency

+ type WalletMetricsQueryOpts struct

type WalletPrepareRenewRequest

+ ExpectedNewStorage uint64

+ MinNewCollateral types.Currency

v0.6.0

Oct 3, 2023

Changes in this version

+ const DefaultBucketName

+ const SettingS3Authentication

+ var ErrBucketExists = errors.New("bucket already exists")

+ var ErrBucketNotEmpty = errors.New("bucket not empty")

+ var ErrBucketNotFound = errors.New("bucket not found")

+ var ErrHostNotFound = errors.New("host doesn't exist in hostdb")

+ var ErrMultipartUploadNotFound = errors.New("multipart upload not found")

+ var ErrPartNotFound = errors.New("multipart upload part not found")

+ func FormatETag(ETag string) string

type Account

+ CleanShutdown bool

type AddPartialSlabResponse

+ SlabBufferMaxSizeSoftReached bool

+ type Bucket struct

+ CreatedAt time.Time

+ Name string

+ Policy BucketPolicy

+ type BucketCreateRequest struct

+ Name string

+ Policy BucketPolicy

+ type BucketPolicy struct

+ PublicReadAccess bool

+ type BucketUpdatePolicyRequest struct

+ Policy BucketPolicy

+ type CopyObjectOptions struct

+ MimeType string

+ type CreateMultipartOptions struct

+ Key object.EncryptionKey

+ MimeType string

type DownloadObjectOption

+ func DownloadWithBucket(bucket string) DownloadObjectOption

+ type DownloadRange struct

+ Length int64

+ Start int64

+ func ParseDownloadRange(contentRange string) (DownloadRange, error)

+ type DurationH time.Duration

+ func (d *DurationH) UnmarshalText(b []byte) error

+ func (d DurationH) MarshalText() ([]byte, error)

+ func (d DurationH) String() string

+ type DurationMS time.Duration

+ func (d *DurationMS) UnmarshalJSON(data []byte) error

+ func (d *DurationMS) UnmarshalText(b []byte) error

+ func (d DurationMS) MarshalJSON() ([]byte, error)

+ func (d DurationMS) MarshalText() ([]byte, error)

+ func (d DurationMS) String() string

+ type GetObjectResponse struct

+ Content io.ReadCloser

+ ContentType string

+ ModTime time.Time

+ Range *DownloadRange

+ Size int64

+ type MigrateSlabResponse struct

+ NumShardsMigrated int

+ type MultipartAbortRequest struct

+ Bucket string

+ Path string

+ UploadID string

+ type MultipartAddPartRequest struct

+ Bucket string

+ ContractSet string

+ ETag string

+ PartNumber int

+ PartialSlabs []object.PartialSlab

+ Path string

+ Slices []object.SlabSlice

+ UploadID string

+ UsedContracts map[types.PublicKey]types.FileContractID

+ type MultipartCompleteRequest struct

+ Bucket string

+ Parts []MultipartCompletedPart

+ Path string

+ UploadID string

+ type MultipartCompleteResponse struct

+ ETag string

+ type MultipartCompletedPart struct

+ ETag string

+ PartNumber int

+ type MultipartCreateRequest struct

+ Bucket string

+ Key object.EncryptionKey

+ MimeType string

+ Path string

+ type MultipartCreateResponse struct

+ UploadID string

+ type MultipartListPartItem struct

+ ETag string

+ LastModified time.Time

+ PartNumber int

+ Size int64

+ type MultipartListPartsRequest struct

+ Bucket string

+ Limit int64

+ PartNumberMarker int

+ Path string

+ UploadID string

+ type MultipartListPartsResponse struct

+ HasMore bool

+ NextMarker int

+ Parts []MultipartListPartItem

+ type MultipartListUploadsRequest struct

+ Bucket string

+ Limit int

+ PathMarker string

+ Prefix string

+ UploadIDMarker string

+ type MultipartListUploadsResponse struct

+ HasMore bool

+ NextPathMarker string

+ NextUploadIDMarker string

+ Uploads []MultipartUpload

+ type MultipartUpload struct

+ Bucket string

+ CreatedAt time.Time

+ Key object.EncryptionKey

+ Path string

+ UploadID string

type ObjectAddRequest

+ Bucket string

+ ETag string

+ MimeType string

type ObjectMetadata

+ ETag string

+ MimeType string

+ ModTime time.Time

+ func (o ObjectMetadata) ContentType() string

+ func (o ObjectMetadata) LastModified() string

+ type ObjectsCopyRequest struct

+ DestinationBucket string

+ DestinationPath string

+ MimeType string

+ SourceBucket string

+ SourcePath string

+ type ObjectsListRequest struct

+ Bucket string

+ Limit int

+ Marker string

+ Prefix string

+ type ObjectsListResponse struct

+ HasMore bool

+ NextMarker string

+ Objects []ObjectMetadata

type ObjectsOption

+ func ObjectsWithBucket(bucket string) ObjectsOption

+ func ObjectsWithIgnoreDelim(ignore bool) ObjectsOption

+ func ObjectsWithMarker(marker string) ObjectsOption

type ObjectsRenameRequest

+ Bucket string

type ObjectsResponse

+ HasMore bool

+ type RHPPruneContractRequest struct

+ Timeout DurationMS

+ type RHPPruneContractResponse struct

+ Pruned uint64

+ Remaining uint64

type RHPScanResponse

+ PriceTable rhpv3.HostPriceTable

+ type S3AuthenticationSettings struct

+ V4Keypairs map[string]string

+ type TimeRFC3339 time.Time

+ func (t *TimeRFC3339) UnmarshalText(b []byte) error

+ func (t TimeRFC3339) MarshalJSON() ([]byte, error)

+ func (t TimeRFC3339) String() string

+ type UploadMultipartUploadPartResponse struct

+ ETag string

+ type UploadObjectResponse struct

+ ETag string

type UploadOption

+ func UploadWithBucket(bucket string) UploadOption

+ func UploadWithDisabledPreshardingEncryption() UploadOption

+ func UploadWithEncryptionOffset(offset int64) UploadOption

+ func UploadWithMimeType(mimeType string) UploadOption

type UploadPackingSettings

+ SlabBufferMaxSizeSoft int64

v0.5.0

Sep 4, 2023

Changes in this version

+ const BlocksPerDay

+ const ContractArchivalReasonHostPruned

+ const ContractArchivalReasonRemoved

+ const ContractArchivalReasonRenewed

+ const DefaultAutopilotID

+ const HostFilterModeAll

+ const HostFilterModeAllowed

+ const HostFilterModeBlocked

+ const ObjectsRenameModeMulti

+ const ObjectsRenameModeSingle

+ const SettingContractSet

+ const SettingGouging

+ const SettingRedundancy

+ const SettingUploadPacking

+ const UsabilityFilterModeAll

+ const UsabilityFilterModeUnusable

+ const UsabilityFilterModeUsable

+ var ErrAutopilotNotFound = errors.New("couldn't find autopilot")

+ var ErrConsensusNotSynced = errors.New("consensus is not synced")

+ var ErrContractNotFound = errors.New("couldn't find contract")

+ var ErrContractSetNotFound = errors.New("couldn't find contract set")

+ var ErrContractSetNotSpecified = errors.New("contract set is not specified")

+ var ErrMaxDowntimeHoursTooHigh = errors.New("MaxDowntimeHours is too high, exceeds max value of 99 years")

+ var ErrObjectCorrupted = errors.New("object corrupted")

+ var ErrObjectNotFound = errors.New("object not found")

+ var ErrRequiresSyncSetRecently = errors.New("account had 'requiresSync' flag set recently")

+ var ErrSettingNotFound = errors.New("setting not found")

+ var ErrUnknownUpload = errors.New("unknown upload")

+ var ErrUploadAlreadyExists = errors.New("upload already exists")

+ type Account struct

+ Balance *big.Int

+ Drift *big.Int

+ HostKey types.PublicKey

+ ID rhpv3.Account

+ RequiresSync bool

+ type AccountHandlerPOST struct

+ HostKey types.PublicKey

+ type AccountsAddBalanceRequest struct

+ Amount *big.Int

+ HostKey types.PublicKey

+ type AccountsLockHandlerRequest struct

+ Duration ParamDuration

+ Exclusive bool

+ HostKey types.PublicKey

+ type AccountsLockHandlerResponse struct

+ Account Account

+ LockID uint64

+ type AccountsRequiresSyncRequest struct

+ HostKey types.PublicKey

+ type AccountsUnlockHandlerRequest struct

+ LockID uint64

+ type AccountsUpdateBalanceRequest struct

+ Amount *big.Int

+ HostKey types.PublicKey

+ type Action struct

+ Action interface{}

+ Timestamp time.Time

+ Type string

+ type AddPartialSlabResponse struct

+ Slabs []object.PartialSlab

+ type ArchiveContractsRequest = map[types.FileContractID]string

+ type ArchivedContract struct

+ HostKey types.PublicKey

+ ID types.FileContractID

+ ProofHeight uint64

+ RenewedTo types.FileContractID

+ RevisionHeight uint64

+ RevisionNumber uint64

+ Size uint64

+ Spending ContractSpending

+ StartHeight uint64

+ WindowEnd uint64

+ WindowStart uint64

+ type Autopilot struct

+ Config AutopilotConfig

+ CurrentPeriod uint64

+ ID string

+ type AutopilotConfig struct

+ Contracts ContractsConfig

+ Hosts HostsConfig

+ Wallet WalletConfig

+ func (c AutopilotConfig) Validate() error

+ type AutopilotStateResponse struct

+ Configured bool

+ Migrating bool

+ MigratingLastStart ParamTime

+ Scanning bool

+ ScanningLastStart ParamTime

+ StartTime time.Time

+ UptimeMS ParamDuration

+ type AutopilotTriggerRequest struct

+ ForceScan bool

+ type AutopilotTriggerResponse struct

+ Triggered bool

+ type BuildState struct

+ BuildTime time.Time

+ Commit string

+ Network string

+ OS string

+ Version string

+ type BusStateResponse struct

+ StartTime time.Time

+ type ConsensusNetwork struct

+ Name string

+ type ConsensusState struct

+ BlockHeight uint64

+ LastBlockTime time.Time

+ Synced bool

+ type Contract struct

+ Revision *types.FileContractRevision

+ func (c Contract) EndHeight() uint64

+ func (c Contract) FileSize() uint64

+ func (c Contract) RemainingCollateral(s rhpv2.HostSettings) types.Currency

+ func (c Contract) RenterFunds() types.Currency

+ type ContractAcquireRequest struct

+ Duration ParamDuration

+ Priority int

+ type ContractAcquireResponse struct

+ LockID uint64

+ type ContractKeepaliveRequest struct

+ Duration ParamDuration

+ LockID uint64

+ type ContractMetadata struct

+ HostIP string

+ HostKey types.PublicKey

+ ID types.FileContractID

+ ProofHeight uint64

+ RenewedFrom types.FileContractID

+ RevisionHeight uint64

+ RevisionNumber uint64

+ SiamuxAddr string

+ Size uint64

+ Spending ContractSpending

+ StartHeight uint64

+ TotalCost types.Currency

+ WindowEnd uint64

+ WindowStart uint64

+ type ContractPrunableData struct

+ ID types.FileContractID

+ type ContractReleaseRequest struct

+ LockID uint64

+ type ContractRootsResponse struct

+ Roots []types.Hash256

+ Uploading []types.Hash256

+ type ContractSetSetting struct

+ Default string

+ type ContractSize struct

+ Prunable uint64

+ Size uint64

+ type ContractSpending struct

+ Deletions types.Currency

+ Downloads types.Currency

+ FundAccount types.Currency

+ SectorRoots types.Currency

+ Uploads types.Currency

+ func (x ContractSpending) Add(y ContractSpending) (z ContractSpending)

+ type ContractSpendingRecord struct

+ ContractID types.FileContractID

+ RevisionNumber uint64

+ Size uint64

+ type ContractsConfig struct

+ Allowance types.Currency

+ Amount uint64

+ Download uint64

+ Period uint64

+ RenewWindow uint64

+ Set string

+ Storage uint64

+ Upload uint64

+ type ContractsIDAddRequest struct

+ Contract rhpv2.ContractRevision

+ StartHeight uint64

+ TotalCost types.Currency

+ type ContractsIDRenewedRequest struct

+ Contract rhpv2.ContractRevision

+ RenewedFrom types.FileContractID

+ StartHeight uint64

+ TotalCost types.Currency

+ type ContractsPrunableDataResponse struct

+ Contracts []ContractPrunableData

+ TotalPrunable uint64

+ TotalSize uint64

+ type ContractsResponse struct

+ Contracts []Contract

+ Error string

+ type DownloadObjectOption func(http.Header)

+ func DownloadWithRange(offset, length uint64) DownloadObjectOption

+ type DownloadStatsResponse struct

+ AvgDownloadSpeedMBPS float64

+ AvgOverdrivePct float64

+ DownloadersStats []DownloaderStats

+ HealthyDownloaders uint64

+ NumDownloaders uint64

+ type DownloaderStats struct

+ AvgSectorDownloadSpeedMBPS float64

+ HostKey types.PublicKey

+ NumDownloads uint64

+ type GougingChecks struct

+ ContractErr string

+ DownloadErr string

+ GougingErr string

+ UploadErr string

+ func (gc GougingChecks) Errors() (errs []string)

+ func (gc GougingChecks) Gouging() bool

+ type GougingParams struct

+ ConsensusState ConsensusState

+ GougingSettings GougingSettings

+ RedundancySettings RedundancySettings

+ TransactionFee types.Currency

+ type GougingSettings struct

+ HostBlockHeightLeeway int

+ MaxContractPrice types.Currency

+ MaxDownloadPrice types.Currency

+ MaxRPCPrice types.Currency

+ MaxStoragePrice types.Currency

+ MaxUploadPrice types.Currency

+ MinAccountExpiry time.Duration

+ MinMaxCollateral types.Currency

+ MinMaxEphemeralAccountBalance types.Currency

+ MinPriceTableValidity time.Duration

+ func (gs GougingSettings) Validate() error

+ type HostGougingBreakdown struct

+ V2 GougingChecks

+ V3 GougingChecks

+ func (hgb HostGougingBreakdown) Gouging() bool

+ func (hgb HostGougingBreakdown) Reasons() string

+ type HostHandlerResponse struct

+ Checks *HostHandlerResponseChecks

+ Host hostdb.Host

+ type HostHandlerResponseChecks struct

+ Gouging bool

+ GougingBreakdown HostGougingBreakdown

+ Score float64

+ ScoreBreakdown HostScoreBreakdown

+ UnusableReasons []string

+ Usable bool

+ type HostScoreBreakdown struct

+ Age float64

+ Collateral float64

+ Interactions float64

+ Prices float64

+ StorageRemaining float64

+ Uptime float64

+ Version float64

+ func (sb HostScoreBreakdown) Score() float64

+ func (sb HostScoreBreakdown) String() string

+ type HostsConfig struct

+ AllowRedundantIPs bool

+ MaxDowntimeHours uint64

+ ScoreOverrides map[types.PublicKey]float64

+ type HostsPriceTablesRequest struct

+ PriceTableUpdates []hostdb.PriceTableUpdate

+ type HostsRemoveRequest struct

+ MaxDowntimeHours ParamDurationHour

+ MinRecentScanFailures uint64

+ type HostsScanRequest struct

+ Scans []hostdb.HostScan

+ type MigrationSlabsRequest struct

+ ContractSet string

+ HealthCutoff float64

+ Limit int

+ type Object struct

+ type ObjectAddRequest struct

+ ContractSet string

+ Object object.Object

+ UsedContracts map[types.PublicKey]types.FileContractID

+ type ObjectMetadata struct

+ Health float64

+ Name string

+ Size int64

+ type ObjectsOption func(url.Values)

+ func ObjectsWithLimit(limit int) ObjectsOption

+ func ObjectsWithOffset(offset int) ObjectsOption

+ func ObjectsWithPrefix(prefix string) ObjectsOption

+ type ObjectsRenameRequest struct

+ From string

+ Mode string

+ To string

+ type ObjectsResponse struct

+ Entries []ObjectMetadata

+ Object *Object

+ type ObjectsStatsResponse struct

+ NumObjects uint64

+ TotalObjectsSize uint64

+ TotalSectorsSize uint64

+ TotalUploadedSize uint64

+ type PackedSlab struct

+ BufferID uint

+ Data []byte

+ Key object.EncryptionKey

+ type PackedSlabsRequestGET struct

+ ContractSet string

+ Limit int

+ LockingDuration ParamDuration

+ MinShards uint8

+ TotalShards uint8

+ type PackedSlabsRequestPOST struct

+ Slabs []UploadedPackedSlab

+ UsedContracts map[types.PublicKey]types.FileContractID

+ type ParamCurrency types.Currency

+ func (c *ParamCurrency) UnmarshalText(b []byte) error

+ func (c ParamCurrency) MarshalText() ([]byte, error)

+ func (c ParamCurrency) String() string

+ type ParamDuration time.Duration

+ func (d *ParamDuration) UnmarshalJSON(data []byte) error

+ func (d *ParamDuration) UnmarshalText(b []byte) error

+ func (d ParamDuration) MarshalJSON() ([]byte, error)

+ func (d ParamDuration) MarshalText() ([]byte, error)

+ func (d ParamDuration) String() string

+ type ParamDurationHour time.Duration

+ func (d *ParamDurationHour) UnmarshalText(b []byte) error

+ func (d ParamDurationHour) MarshalText() ([]byte, error)

+ func (d ParamDurationHour) String() string

+ type ParamString string

+ func (s *ParamString) UnmarshalText(b []byte) error

+ func (s ParamString) MarshalText() ([]byte, error)

+ func (s ParamString) String() string

+ type ParamTime time.Time

+ func (t *ParamTime) UnmarshalText(b []byte) error

+ func (t ParamTime) MarshalJSON() ([]byte, error)

+ func (t ParamTime) String() string

+ type RHPFormRequest struct

+ EndHeight uint64

+ HostCollateral types.Currency

+ HostIP string

+ HostKey types.PublicKey

+ RenterAddress types.Address

+ RenterFunds types.Currency

+ type RHPFormResponse struct

+ Contract rhpv2.ContractRevision

+ ContractID types.FileContractID

+ TransactionSet []types.Transaction

+ type RHPFundRequest struct

+ Balance types.Currency

+ ContractID types.FileContractID

+ HostKey types.PublicKey

+ SiamuxAddr string

+ type RHPPreparePaymentRequest struct

+ Account rhpv3.Account

+ AccountKey types.PrivateKey

+ Amount types.Currency

+ Expiry uint64

+ type RHPPriceTableRequest struct

+ HostKey types.PublicKey

+ SiamuxAddr string

+ Timeout time.Duration

+ type RHPRegistryReadRequest struct

+ HostKey types.PublicKey

+ Payment rhpv3.PayByEphemeralAccountRequest

+ RegistryKey rhpv3.RegistryKey

+ SiamuxAddr string

+ type RHPRegistryUpdateRequest struct

+ HostKey types.PublicKey

+ RegistryKey rhpv3.RegistryKey

+ RegistryValue rhpv3.RegistryValue

+ SiamuxAddr string

+ type RHPRenewRequest struct

+ ContractID types.FileContractID

+ EndHeight uint64

+ HostAddress types.Address

+ HostKey types.PublicKey

+ NewCollateral types.Currency

+ RenterAddress types.Address

+ RenterFunds types.Currency

+ SiamuxAddr string

+ WindowSize uint64

+ type RHPRenewResponse struct

+ Contract rhpv2.ContractRevision

+ ContractID types.FileContractID

+ Error string

+ TransactionSet []types.Transaction

+ type RHPScanRequest struct

+ HostIP string

+ HostKey types.PublicKey

+ Timeout time.Duration

+ type RHPScanResponse struct

+ Ping ParamDuration

+ ScanError string

+ Settings rhpv2.HostSettings

+ type RHPSyncRequest struct

+ ContractID types.FileContractID

+ HostKey types.PublicKey

+ SiamuxAddr string

+ type RedundancySettings struct

+ MinShards int

+ TotalShards int

+ func (rs RedundancySettings) Redundancy() float64

+ func (rs RedundancySettings) Validate() error

+ type SearchHostsRequest struct

+ AddressContains string

+ FilterMode string

+ KeyIn []types.PublicKey

+ Limit int

+ Offset int

+ UsabilityMode string

+ type SlabBuffer struct

+ Complete bool

+ ContractSet string

+ Filename string

+ Locked bool

+ MaxSize int64

+ Size int64

+ type SlabID uint

+ func (sid *SlabID) LoadString(s string) (err error)

+ func (sid SlabID) String() string

+ type UnhealthySlab struct

+ Health float64

+ Key object.EncryptionKey

+ type UnhealthySlabsResponse struct

+ Slabs []UnhealthySlab

+ type UpdateAllowlistRequest struct

+ Add []types.PublicKey

+ Clear bool

+ Remove []types.PublicKey

+ type UpdateBlocklistRequest struct

+ Add []string

+ Clear bool

+ Remove []string

+ type UpdateSlabRequest struct

+ ContractSet string

+ Slab object.Slab

+ UsedContracts map[types.PublicKey]types.FileContractID

+ type UploadID [8]byte

+ func NewUploadID() (uID UploadID)

+ func (uID *UploadID) UnmarshalText(b []byte) error

+ func (uID UploadID) MarshalText() ([]byte, error)

+ func (uID UploadID) String() string

+ type UploadOption func(url.Values)

+ func UploadWithContractSet(set string) UploadOption

+ func UploadWithRedundancy(minShards, totalShards int) UploadOption

+ type UploadPackingSettings struct

+ Enabled bool

+ type UploadParams struct

+ ContractSet string

+ CurrentHeight uint64

+ UploadPacking bool

+ type UploadSectorRequest struct

+ ContractID types.FileContractID

+ Root types.Hash256

+ type UploadStatsResponse struct

+ AvgOverdrivePct float64

+ AvgSlabUploadSpeedMBPS float64

+ HealthyUploaders uint64

+ NumUploaders uint64

+ UploadersStats []UploaderStats

+ type UploadedPackedSlab struct

+ BufferID uint

+ Shards []object.Sector

+ type UploaderStats struct

+ AvgSectorUploadSpeedMBPS float64

+ HostKey types.PublicKey

+ type WalletConfig struct

+ DefragThreshold uint64

+ type WalletFundRequest struct

+ Amount types.Currency

+ Transaction types.Transaction

+ type WalletFundResponse struct

+ DependsOn []types.Transaction

+ ToSign []types.Hash256

+ Transaction types.Transaction

+ type WalletPrepareFormRequest struct

+ EndHeight uint64

+ HostCollateral types.Currency

+ HostKey types.PublicKey

+ HostSettings rhpv2.HostSettings

+ RenterAddress types.Address

+ RenterFunds types.Currency

+ RenterKey types.PublicKey

+ type WalletPrepareRenewRequest struct

+ EndHeight uint64

+ HostAddress types.Address

+ HostKey types.PublicKey

+ NewCollateral types.Currency

+ PriceTable rhpv3.HostPriceTable

+ RenterAddress types.Address

+ RenterFunds types.Currency

+ RenterKey types.PrivateKey

+ Revision types.FileContractRevision

+ WindowSize uint64

+ type WalletPrepareRenewResponse struct

+ ToSign []types.Hash256

+ TransactionSet []types.Transaction

+ type WalletRedistributeRequest struct

+ Amount types.Currency

+ Outputs int

+ type WalletResponse struct

+ Address types.Address

+ Confirmed types.Currency

+ ScanHeight uint64

+ Spendable types.Currency

+ Unconfirmed types.Currency

+ type WalletSignRequest struct

+ CoveredFields types.CoveredFields

+ ToSign []types.Hash256

+ Transaction types.Transaction

+ type WalletTransactionsOption func(url.Values)

+ func WalletTransactionsWithBefore(before time.Time) WalletTransactionsOption

+ func WalletTransactionsWithLimit(limit int) WalletTransactionsOption

+ func WalletTransactionsWithOffset(offset int) WalletTransactionsOption

+ func WalletTransactionsWithSince(since time.Time) WalletTransactionsOption

+ type WebHookResponse struct

+ Queues []webhooks.WebhookQueueInfo

+ Webhooks []webhooks.Webhook

+ type WorkerStateResponse struct

+ ID string

+ StartTime time.Time

v0.4.0-beta

Jul 10, 2023

v0.3.0-beta

Apr 28, 2023

v0.2.0-beta

Apr 14, 2023

v0.1.0-beta

Apr 1, 2023

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