api

package

Go to main page

Versions in this module

v1

v1.4.13

Oct 29, 2021

Changes in this version

+ const DefaultSkynetRequestTimeout

+ const MaxSkynetRequestTimeout

+ const StatusModuleNotLoaded

+ var ErrAPICallNotRecognized = errors.New("API call not recognized")

+ var ErrFundsNeedToBeSet = errors.New("funds needs to be set if it hasn't been set before")

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

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

+ var ErrPeriodNeedToBeSet = errors.New("period needs to be set if it hasn't been set before")

+ func NewLimitStreamer(s modules.Streamer, offset, size uint64) (modules.Streamer, error)

+ func ParseDataAndParityPieces(strDataPieces, strParityPieces string) (dataPieces, parityPieces int, err error)

type API

+ Shutdown func() error

+ func (api *API) SetModules(cs modules.ConsensusSet, e modules.Explorer, fm modules.FeeManager, ...)

+ func (api *API) StartTime() time.Time

type ConsensusBlocksGet

+ Difficulty types.Currency

+ type DaemonAlertsGet struct

+ Alerts []modules.Alert

+ CriticalAlerts []modules.Alert

+ ErrorAlerts []modules.Alert

+ WarningAlerts []modules.Alert

+ type DaemonSettingsGet struct

+ MaxDownloadSpeed int64

+ MaxUploadSpeed int64

+ Modules configModules

+ type DaemonVersion struct

+ BuildTime string

+ GitRevision string

+ Version string

+ type FeeManagerAddFeePOST struct

+ FeeUID modules.FeeUID

+ type FeeManagerGET struct

+ PayoutHeight types.BlockHeight

+ type FeeManagerPaidFeesGET struct

+ PaidFees []modules.AppFee

+ type FeeManagerPendingFeesGET struct

+ PendingFees []modules.AppFee

+ type GatewayBandwidthGET struct

+ Download uint64

+ StartTime time.Time

+ Upload uint64

+ type GatewayBlacklistGET struct

+ Blacklist []string

+ type GatewayBlacklistPOST struct

+ Action string

+ Addresses []string

type GatewayGET

+ Online bool

+ type HalfLifeDistribution struct

+ FifteenMinutes RequestTimeDistribution

+ FiveMinutes RequestTimeDistribution

+ LastUpdate time.Time

+ Lifetime RequestTimeDistribution

+ OneMinute RequestTimeDistribution

+ TwentyFourHours RequestTimeDistribution

+ func NewHalfLifeDistribution() HalfLifeDistribution

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

+ func (hld *HalfLifeDistribution) Update()

type HostGET

+ PublicKey types.SiaPublicKey

+ type HostdbFilterModeGET struct

+ FilterMode string

+ Hosts []string

+ type RenterBackupsGET struct

+ Backups []RenterUploadedBackup

+ SyncedHosts []types.SiaPublicKey

+ UnsyncedHosts []types.SiaPublicKey

type RenterContract

+ BadContract bool

type RenterContracts

+ DisabledContracts []RenterContract

+ ExpiredRefreshedContracts []RenterContract

+ PassiveContracts []RenterContract

+ RefreshedContracts []RenterContract

+ type RenterFuseInfo struct

+ MountPoints []modules.MountInfo

type RenterGET

+ NextPeriod types.BlockHeight

+ type RenterUploadReadyGet struct

+ ContractsNeeded int

+ DataPieces int

+ NumActiveContracts int

+ ParityPieces int

+ Ready bool

+ type RenterUploadedBackup struct

+ CreationDate types.Timestamp

+ Name string

+ Size uint64

+ UploadProgress float64

+ type RequestTimeDistribution struct

+ N1000ms float64

+ N10s float64

+ N120ms float64

+ N2000ms float64

+ N240ms float64

+ N5000ms float64

+ N500ms float64

+ N60ms float64

+ NErr float64

+ NLong float64

+ type SiaConstants struct

+ BlockFrequency types.BlockHeight

+ BlockSizeLimit uint64

+ DefaultAllowance modules.Allowance

+ ExtremeFutureThreshold types.Timestamp

+ FutureThreshold types.Timestamp

+ GenesisTimestamp types.Timestamp

+ InitialCoinbase uint64

+ MaturityDelay types.BlockHeight

+ MaxAdjustmentDown *big.Rat

+ MaxAdjustmentUp *big.Rat

+ MaxTargetAdjustmentDown *big.Rat

+ MaxTargetAdjustmentUp *big.Rat

+ MedianTimestampWindow uint64

+ MinimumCoinbase uint64

+ RootDepth types.Target

+ RootTarget types.Target

+ SiacoinPrecision types.Currency

+ SiafundCount types.Currency

+ SiafundPortion *big.Rat

+ TargetWindow types.BlockHeight

+ type SkykeyGET struct

+ ID string

+ Name string

+ Skykey string

+ Type string

+ type SkykeysGET struct

+ Skykeys []SkykeyGET

+ type SkynetBlacklistGET struct

+ Blacklist []crypto.Hash

+ type SkynetBlacklistPOST struct

+ Add []string

+ Remove []string

+ type SkynetPerformanceStats struct

+ Download1MB HalfLifeDistribution

+ Download4MB HalfLifeDistribution

+ Download64KB HalfLifeDistribution

+ DownloadLarge HalfLifeDistribution

+ TimeToFirstByte HalfLifeDistribution

+ Upload4MB HalfLifeDistribution

+ UploadLarge HalfLifeDistribution

+ func NewSkynetPerformanceStats() *SkynetPerformanceStats

+ func (sps *SkynetPerformanceStats) Copy() SkynetPerformanceStats

+ func (sps *SkynetPerformanceStats) Update()

+ type SkynetPortalsGET struct

+ Portals []modules.SkynetPortal

+ type SkynetPortalsPOST struct

+ Add []modules.SkynetPortal

+ Remove []modules.NetAddress

+ type SkynetSkyfileHandlerPOST struct

+ Bitfield uint16

+ MerkleRoot crypto.Hash

+ Skylink string

+ type SkynetStats struct

+ NumFiles int

+ TotalSize uint64

+ type SkynetStatsGET struct

+ PerformanceStats SkynetPerformanceStats

+ UploadStats SkynetStats

+ Uptime int64

+ VersionInfo SkynetVersion

+ type SkynetVersion struct

+ GitRevision string

+ Version string

+ type TpoolTxnsGET struct

+ Transactions []types.Transaction

+ type UpdateInfo struct

+ Available bool

+ Version string

type WalletSiacoinsPOST

+ Transactions []types.Transaction

type WalletSiafundsPOST

+ Transactions []types.Transaction

+ type WalletVerifyPasswordGET struct

+ Valid bool

v1.4.0

Apr 1, 2019

Changes in this version

type ConsensusGET

+ BlockFrequency types.BlockHeight

+ BlockSizeLimit uint64

+ ExtremeFutureThreshold types.Timestamp

+ FutureThreshold types.Timestamp

+ GenesisTimestamp types.Timestamp

+ InitialCoinbase uint64

+ MaturityDelay types.BlockHeight

+ MedianTimestampWindow uint64

+ MinimumCoinbase uint64

+ RootDepth types.Target

+ RootTarget types.Target

+ SiacoinPrecision types.Currency

+ SiafundCount types.Currency

+ SiafundPortion *big.Rat

type GatewayGET

+ MaxDownloadSpeed int64

+ MaxUploadSpeed int64

+ type HostdbFilterModePOST struct

+ FilterMode string

+ Hosts []types.SiaPublicKey

type RenterContract

+ HostVersion string

type RenterContracts

+ RecoverableContracts []modules.RecoverableContract

+ type RenterDirectory struct

+ Directories []modules.DirectoryInfo

+ Files []modules.FileInfo

+ type RenterRecoveryStatusGET struct

+ ScanInProgress bool

+ ScannedHeight types.BlockHeight

v1.3.7

Oct 22, 2018

v1.3.6

Oct 16, 2018

v1.3.5

Oct 16, 2018

Changes in this version

+ type WalletSignPOSTParams struct

+ ToSign []crypto.Hash

+ Transaction types.Transaction

+ type WalletSignPOSTResp struct

+ Transaction types.Transaction

+ type WalletUnlockConditionsGET struct

+ UnlockConditions types.UnlockConditions

+ type WalletUnlockConditionsPOSTParams struct

+ UnlockConditions types.UnlockConditions

+ type WalletUnspentGET struct

+ Outputs []modules.UnspentOutput

+ type WalletWatchGET struct

+ Addresses []types.UnlockHash

+ type WalletWatchPOST struct

+ Addresses []types.UnlockHash

+ Remove bool

+ Unused bool

v1.3.4

Sep 5, 2018

Changes in this version

type DownloadInfo

+ StartTimeUnix int64

type RenterContracts

+ ActiveContracts []RenterContract

+ ExpiredContracts []RenterContract

+ InactiveContracts []RenterContract

v1.3.3

Jun 12, 2018

Changes in this version

+ type ConsensusBlocksGet struct

+ Height types.BlockHeight

+ ID types.BlockID

+ MinerPayouts []types.SiacoinOutput

+ Nonce types.BlockNonce

+ ParentID types.BlockID

+ Timestamp types.Timestamp

+ Transactions []ConsensusBlocksGetTxn

+ type ConsensusBlocksGetFileContract struct

+ FileMerkleRoot crypto.Hash

+ FileSize uint64

+ ID types.FileContractID

+ MissedProofOutputs []ConsensusBlocksGetSiacoinOutput

+ Payout types.Currency

+ RevisionNumber uint64

+ UnlockHash types.UnlockHash

+ ValidProofOutputs []ConsensusBlocksGetSiacoinOutput

+ WindowEnd types.BlockHeight

+ WindowStart types.BlockHeight

+ type ConsensusBlocksGetSiacoinOutput struct

+ ID types.SiacoinOutputID

+ UnlockHash types.UnlockHash

+ Value types.Currency

+ type ConsensusBlocksGetSiafundOutput struct

+ ID types.SiafundOutputID

+ UnlockHash types.UnlockHash

+ Value types.Currency

+ type ConsensusBlocksGetTxn struct

+ ArbitraryData [][]byte

+ FileContractRevisions []types.FileContractRevision

+ FileContracts []ConsensusBlocksGetFileContract

+ ID types.TransactionID

+ MinerFees []types.Currency

+ SiacoinInputs []types.SiacoinInput

+ SiacoinOutputs []ConsensusBlocksGetSiacoinOutput

+ SiafundInputs []types.SiafundInput

+ SiafundOutputs []ConsensusBlocksGetSiafundOutput

+ StorageProofs []types.StorageProof

+ TransactionSignatures []types.TransactionSignature

+ type ConsensusHeadersGET struct

+ BlockID types.BlockID

+ type ContractInfoGET struct

+ Contracts []modules.StorageObligation

+ type DaemonUpdateGet struct

+ Available bool

+ Version string

+ type HostdbGet struct

+ InitialScanComplete bool

+ type RenterFile struct

+ File modules.FileInfo

v1.3.2

Mar 13, 2018

Changes in this version

+ func HttpGET(url string) (resp *http.Response, err error)

+ func HttpGETAuthenticated(url string, password string) (resp *http.Response, err error)

+ func HttpPOST(url string, data string) (resp *http.Response, err error)

+ func HttpPOSTAuthenticated(url string, data string, password string) (resp *http.Response, err error)

+ func RequirePassword(h httprouter.Handle, password string) httprouter.Handle

+ func RequireUserAgent(h http.Handler, ua string) http.Handler

+ func UnrecognizedCallHandler(w http.ResponseWriter, req *http.Request)

+ func WriteError(w http.ResponseWriter, err Error, code int)

+ func WriteJSON(w http.ResponseWriter, obj interface{})

+ func WriteSuccess(w http.ResponseWriter)

+ type API struct

+ func New(requiredUserAgent string, requiredPassword string, cs modules.ConsensusSet, ...) *API

+ func (api *API) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type ConsensusGET struct

+ CurrentBlock types.BlockID

+ Difficulty types.Currency

+ Height types.BlockHeight

+ Synced bool

+ Target types.Target

+ type DaemonVersionGet struct

+ BuildTime string

+ GitRevision string

+ Version string

+ type DownloadInfo struct

+ Completed bool

+ Destination string

+ DestinationType string

+ EndTime time.Time

+ Error string

+ Filesize uint64

+ Length uint64

+ Offset uint64

+ Received uint64

+ SiaPath string

+ StartTime time.Time

+ TotalDataTransferred uint64

+ type Error struct

+ Message string

+ func (err Error) Error() string

+ type ExplorerBlock struct

+ MinerPayoutIDs []types.SiacoinOutputID

+ RawBlock types.Block

+ Transactions []ExplorerTransaction

+ type ExplorerBlockGET struct

+ Block ExplorerBlock

+ type ExplorerGET struct

+ type ExplorerHashGET struct

+ Block ExplorerBlock

+ Blocks []ExplorerBlock

+ HashType string

+ Transaction ExplorerTransaction

+ Transactions []ExplorerTransaction

+ type ExplorerTransaction struct

+ FileContractIDs []types.FileContractID

+ FileContractMissedProofOutputIDs [][]types.SiacoinOutputID

+ FileContractRevisionMissedProofOutputIDs [][]types.SiacoinOutputID

+ FileContractRevisionValidProofOutputIDs [][]types.SiacoinOutputID

+ FileContractValidProofOutputIDs [][]types.SiacoinOutputID

+ Height types.BlockHeight

+ ID types.TransactionID

+ Parent types.BlockID

+ RawTransaction types.Transaction

+ SiacoinInputOutputs []types.SiacoinOutput

+ SiacoinOutputIDs []types.SiacoinOutputID

+ SiafundClaimOutputIDs []types.SiacoinOutputID

+ SiafundInputOutputs []types.SiafundOutput

+ SiafundOutputIDs []types.SiafundOutputID

+ StorageProofOutputIDs [][]types.SiacoinOutputID

+ StorageProofOutputs [][]types.SiacoinOutput

+ type ExtendedHostDBEntry struct

+ PublicKeyString string

+ type GatewayGET struct

+ NetAddress modules.NetAddress

+ Peers []modules.Peer

+ type HostEstimateScoreGET struct

+ ConversionRate float64

+ EstimatedScore types.Currency

+ type HostGET struct

+ ConnectabilityStatus modules.HostConnectabilityStatus

+ ExternalSettings modules.HostExternalSettings

+ FinancialMetrics modules.HostFinancialMetrics

+ InternalSettings modules.HostInternalSettings

+ NetworkMetrics modules.HostNetworkMetrics

+ WorkingStatus modules.HostWorkingStatus

+ type HostdbActiveGET struct

+ Hosts []ExtendedHostDBEntry

+ type HostdbAllGET struct

+ Hosts []ExtendedHostDBEntry

+ type HostdbHostsGET struct

+ Entry ExtendedHostDBEntry

+ ScoreBreakdown modules.HostScoreBreakdown

+ type MinerGET struct

+ BlocksMined int

+ CPUHashrate int

+ CPUMining bool

+ StaleBlocksMined int

+ type RenterContract struct

+ DownloadSpending types.Currency

+ EndHeight types.BlockHeight

+ Fees types.Currency

+ GoodForRenew bool

+ GoodForUpload bool

+ HostPublicKey types.SiaPublicKey

+ ID types.FileContractID

+ LastTransaction types.Transaction

+ NetAddress modules.NetAddress

+ RenterFunds types.Currency

+ Size uint64

+ StartHeight types.BlockHeight

+ StorageSpending types.Currency

+ StorageSpendingDeprecated types.Currency

+ TotalCost types.Currency

+ UploadSpending types.Currency

+ type RenterContracts struct

+ Contracts []RenterContract

+ type RenterDownloadQueue struct

+ Downloads []DownloadInfo

+ type RenterFiles struct

+ Files []modules.FileInfo

+ type RenterGET struct

+ CurrentPeriod types.BlockHeight

+ FinancialMetrics modules.ContractorSpending

+ Settings modules.RenterSettings

+ type RenterLoad struct

+ FilesAdded []string

+ type RenterPricesGET struct

+ type RenterShareASCII struct

+ ASCIIsia string

+ type StorageGET struct

+ Folders []modules.StorageFolderMetadata

+ type TpoolConfirmedGET struct

+ Confirmed bool

+ type TpoolFeeGET struct

+ Maximum types.Currency

+ Minimum types.Currency

+ type TpoolRawGET struct

+ ID types.TransactionID

+ Parents []byte

+ Transaction []byte

+ type WalletAddressGET struct

+ Address types.UnlockHash

+ type WalletAddressesGET struct

+ Addresses []types.UnlockHash

+ type WalletGET struct

+ ConfirmedSiacoinBalance types.Currency

+ DustThreshold types.Currency

+ Encrypted bool

+ Height types.BlockHeight

+ Rescanning bool

+ SiacoinClaimBalance types.Currency

+ SiafundBalance types.Currency

+ UnconfirmedIncomingSiacoins types.Currency

+ UnconfirmedOutgoingSiacoins types.Currency

+ Unlocked bool

+ type WalletInitPOST struct

+ PrimarySeed string

+ type WalletSeedsGET struct

+ AddressesRemaining int

+ AllSeeds []string

+ PrimarySeed string

+ type WalletSiacoinsPOST struct

+ TransactionIDs []types.TransactionID

+ type WalletSiafundsPOST struct

+ TransactionIDs []types.TransactionID

+ type WalletSweepPOST struct

+ Coins types.Currency

+ Funds types.Currency

+ type WalletTransactionGETid struct

+ Transaction modules.ProcessedTransaction

+ type WalletTransactionsGET struct

+ ConfirmedTransactions []modules.ProcessedTransaction

+ UnconfirmedTransactions []modules.ProcessedTransaction

+ type WalletTransactionsGETaddr struct

+ ConfirmedTransactions []modules.ProcessedTransaction

+ UnconfirmedTransactions []modules.ProcessedTransaction

+ type WalletVerifyAddressGET struct

+ Valid bool

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