client

package

Go to main page

Versions in this module

v1

v1.4.13

Oct 29, 2021

Changes in this version

+ const HostParamEphemeralAccountExpiry

+ const HostParamMaxEphemeralAccountBalance

+ const HostParamMaxEphemeralAccountRisk

type AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithMaxContractPrice(price types.Currency) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithMaxDownloadBandwidthPrice(price types.Currency) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithMaxPeriodChurn(maxPeriodChurn uint64) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithMaxRPCPrice(price types.Currency) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithMaxSectorAccessPrice(price types.Currency) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithMaxStoragePrice(price types.Currency) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithMaxUploadBandwidthPrice(price types.Currency) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithPaymentContractInitialFunding(price types.Currency) *AllowanceRequestPost

type Client

+ func (c *Client) ConsensusSetSubscribe(subscriber modules.ConsensusSetSubscriber, ccid modules.ConsensusChangeID, ...) (<-chan error, func())

+ func (c *Client) ConsensusSubscribeSingle(subscriber modules.ConsensusSetSubscriber, ccid modules.ConsensusChangeID, ...) (modules.ConsensusChangeID, error)

+ func (c *Client) DaemonAlertsGet() (dag api.DaemonAlertsGet, err error)

+ func (c *Client) DaemonGlobalRateLimitPost(downloadSpeed, uploadSpeed int64) (err error)

+ func (c *Client) DaemonSettingsGet() (dsg api.DaemonSettingsGet, err error)

+ func (c *Client) FeeManagerAddPost(address types.UnlockHash, amount types.Currency, appUID modules.AppUID, ...) (fmap api.FeeManagerAddFeePOST, err error)

+ func (c *Client) FeeManagerCancelPost(feeUID modules.FeeUID) (err error)

+ func (c *Client) FeeManagerGet() (fmg api.FeeManagerGET, err error)

+ func (c *Client) FeeManagerPaidFeesGet() (pfg api.FeeManagerPaidFeesGET, err error)

+ func (c *Client) FeeManagerPendingFeesGet() (pfg api.FeeManagerPendingFeesGET, err error)

+ func (c *Client) GatewayAppendBlacklistPost(addresses []string) (err error)

+ func (c *Client) GatewayBandwidthGet() (gbg api.GatewayBandwidthGET, err error)

+ func (c *Client) GatewayBlacklistGet() (gbg api.GatewayBlacklistGET, err error)

+ func (c *Client) GatewayRemoveBlacklistPost(addresses []string) (err error)

+ func (c *Client) GatewaySetBlacklistPost(addresses []string) (err error)

+ func (c *Client) HostBandwidthGet() (gbg api.GatewayBandwidthGET, err error)

+ func (c *Client) HostDbFilterModeGet() (hdfmg api.HostdbFilterModeGET, err error)

+ func (c *Client) MinerBlockPost(b types.Block) (err error)

+ func (c *Client) RenterAllContractsGet() (rc api.RenterContracts, err error)

+ func (c *Client) RenterAllowanceCancelPost() (err error)

+ func (c *Client) RenterBackups() (ubs api.RenterBackupsGET, err error)

+ func (c *Client) RenterBackupsOnHost(host types.SiaPublicKey) (ubs api.RenterBackupsGET, err error)

+ func (c *Client) RenterCancelDownloadPost(id modules.DownloadID) (err error)

+ func (c *Client) RenterContractStatus(fcID types.FileContractID) (status modules.ContractWatchStatus, err error)

+ func (c *Client) RenterContractorChurnStatus() (churnStatus modules.ContractorChurnStatus, err error)

+ func (c *Client) RenterCreateLocalBackupPost(dst string) (err error)

+ func (c *Client) RenterDirCreateWithModePost(siaPath modules.SiaPath, mode os.FileMode) (err error)

+ func (c *Client) RenterDirDeleteRootPost(siaPath modules.SiaPath) (err error)

+ func (c *Client) RenterDirGet(siaPath modules.SiaPath) (rd api.RenterDirectory, err error)

+ func (c *Client) RenterDirRootGet(siaPath modules.SiaPath) (rd api.RenterDirectory, err error)

+ func (c *Client) RenterDisabledContractsGet() (rc api.RenterContracts, err error)

+ func (c *Client) RenterDownloadInfoGet(uid modules.DownloadID) (di api.DownloadInfo, err error)

+ func (c *Client) RenterFileDeletePost(siaPath modules.SiaPath) (err error)

+ func (c *Client) RenterFileDeleteRootPost(siaPath modules.SiaPath) (err error)

+ func (c *Client) RenterFileRootGet(siaPath modules.SiaPath) (rf api.RenterFile, err error)

+ func (c *Client) RenterFuse() (fi api.RenterFuseInfo, err error)

+ func (c *Client) RenterFuseMount(mount string, siaPath modules.SiaPath, opts modules.MountOptions) (err error)

+ func (c *Client) RenterFuseUnmount(mount string) (err error)

+ func (c *Client) RenterRateLimitPost(readBPS, writeBPS int64) (err error)

+ func (c *Client) RenterRecoverLocalBackupPost(src string) (err error)

+ func (c *Client) RenterSetFileStuckPost(siaPath modules.SiaPath, stuck bool) (err error)

+ func (c *Client) RenterSkyfileGet(siaPath modules.SiaPath, root bool) (rf api.RenterFile, err error)

+ func (c *Client) RenterUploadReadyDefaultGet() (rur api.RenterUploadReadyGet, err error)

+ func (c *Client) RenterUploadReadyGet(dataPieces, parityPieces uint64) (rur api.RenterUploadReadyGet, err error)

+ func (c *Client) RenterUploadStreamPost(r io.Reader, siaPath modules.SiaPath, dataPieces, parityPieces uint64, ...) error

+ func (c *Client) RenterUploadStreamRepairPost(r io.Reader, siaPath modules.SiaPath) error

+ func (c *Client) RenterUploadsPausePost(duration time.Duration) (err error)

+ func (c *Client) RenterUploadsResumePost() (err error)

+ func (c *Client) RenterValidateSiaPathPost(siaPathStr string) (err error)

+ func (c *Client) RenterWorkersGet() (wps modules.WorkerPoolStatus, err error)

+ func (c *Client) SkykeyAddKeyPost(sk skykey.Skykey) error

+ func (c *Client) SkykeyCreateKeyPost(name string, skType skykey.SkykeyType) (skykey.Skykey, error)

+ func (c *Client) SkykeyGetByID(id skykey.SkykeyID) (skykey.Skykey, error)

+ func (c *Client) SkykeyGetByName(name string) (skykey.Skykey, error)

+ func (c *Client) SkykeySkykeysGet() ([]skykey.Skykey, error)

+ func (c *Client) SkynetBlacklistGet() (blacklist api.SkynetBlacklistGET, err error)

+ func (c *Client) SkynetBlacklistPost(additions, removals []string) (err error)

+ func (c *Client) SkynetConvertSiafileToSkyfilePost(lup modules.SkyfileUploadParameters, convert modules.SiaPath) (string, error)

+ func (c *Client) SkynetPortalsGet() (portals api.SkynetPortalsGET, err error)

+ func (c *Client) SkynetPortalsPost(additions []modules.SkynetPortal, removals []modules.NetAddress) (err error)

+ func (c *Client) SkynetSkyfileMultiPartPost(params modules.SkyfileMultipartUploadParameters) (string, api.SkynetSkyfileHandlerPOST, error)

+ func (c *Client) SkynetSkyfilePost(params modules.SkyfileUploadParameters) (string, api.SkynetSkyfileHandlerPOST, error)

+ func (c *Client) SkynetSkyfilePostDisableForce(params modules.SkyfileUploadParameters, disableForce bool) (string, api.SkynetSkyfileHandlerPOST, error)

+ func (c *Client) SkynetSkylinkConcatGet(skylink string) ([]byte, modules.SkyfileMetadata, error)

+ func (c *Client) SkynetSkylinkConcatReaderGet(skylink string) (io.ReadCloser, error)

+ func (c *Client) SkynetSkylinkGet(skylink string) ([]byte, modules.SkyfileMetadata, error)

+ func (c *Client) SkynetSkylinkGetWithTimeout(skylink string, timeout int) ([]byte, modules.SkyfileMetadata, error)

+ func (c *Client) SkynetSkylinkHead(skylink string, timeout int) (int, http.Header, error)

+ func (c *Client) SkynetSkylinkPinPost(skylink string, params modules.SkyfilePinParameters) error

+ func (c *Client) SkynetSkylinkPinPostWithTimeout(skylink string, params modules.SkyfilePinParameters, timeout int) error

+ func (c *Client) SkynetSkylinkReaderGet(skylink string) (io.ReadCloser, error)

+ func (c *Client) SkynetSkylinkTarGzReaderGet(skylink string) (io.ReadCloser, error)

+ func (c *Client) SkynetSkylinkTarReaderGet(skylink string) (io.ReadCloser, error)

+ func (c *Client) SkynetStatsGet() (stats api.SkynetStatsGET, err error)

+ func (c *Client) TransactionPoolTransactionsGet() (tptg api.TpoolTxnsGET, err error)

+ func (c *Client) WalletChangePasswordWithSeedPost(seed modules.Seed, newPassword string) (err error)

+ func (c *Client) WalletVerifyPasswordGet(password string) (wvpg api.WalletVerifyPasswordGET, err error)

+ func (c *Client) WalletVerifyPasswordSeedGet(seed modules.Seed) (wvpg api.WalletVerifyPasswordGET, err error)

+ type Options struct

+ Address string

+ Password string

+ UserAgent string

+ func DefaultOptions() (Options, error)

+ type UnsafeClient struct

+ func NewUnsafeClient(client Client) *UnsafeClient

+ func (uc *UnsafeClient) Get(resource string, obj interface{}) error

+ func (uc *UnsafeClient) Post(resource string, data string, obj interface{}) error

v1.4.0

Apr 1, 2019

Changes in this version

+ const HostParamMinBaseRPCPrice

+ const HostParamMinSectorAccessPrice

+ type AllowanceRequestPost struct

+ func (a *AllowanceRequestPost) Send() (err error)

+ func (a *AllowanceRequestPost) WithExpectedDownload(expectedDownload uint64) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithExpectedRedundancy(expectedRedundancy float64) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithExpectedStorage(expectedStorage uint64) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithExpectedUpload(expectedUpload uint64) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithFunds(funds types.Currency) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithHosts(hosts uint64) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithPeriod(period types.BlockHeight) *AllowanceRequestPost

+ func (a *AllowanceRequestPost) WithRenewWindow(renewWindow types.BlockHeight) *AllowanceRequestPost

type Client

+ func (c *Client) GatewayRateLimitPost(downloadSpeed, uploadSpeed int64) (err error)

+ func (c *Client) HostDbFilterModePost(fm modules.FilterMode, hosts []types.SiaPublicKey) (err error)

+ func (c *Client) RenterContractRecoveryProgressGet() (rrs api.RenterRecoveryStatusGET, err error)

+ func (c *Client) RenterCreateBackupPost(dst string) (err error)

+ func (c *Client) RenterDirCreatePost(siaPath string) (err error)

+ func (c *Client) RenterDirDeletePost(siaPath string) (err error)

+ func (c *Client) RenterDirRenamePost(siaPath, newSiaPath string) (err error)

+ func (c *Client) RenterGetDir(siaPath string) (rd api.RenterDirectory, err error)

+ func (c *Client) RenterInitContractRecoveryScanPost() (err error)

+ func (c *Client) RenterPostPartialAllowance() *AllowanceRequestPost

+ func (c *Client) RenterRecoverBackupPost(src string) (err error)

+ func (c *Client) RenterRecoverableContractsGet() (rc api.RenterContracts, err error)

+ func (c *Client) RenterSetCheckIPViolationPost(enabled bool) (err error)

+ func (c *Client) RenterUploadForcePost(path, siaPath string, dataPieces, parityPieces uint64, force bool) (err error)

+ func (c *Client) WalletLastAddressesGet(count uint64) (wag api.WalletAddressesGET, err error)

v1.3.7

Oct 22, 2018

v1.3.6

Oct 16, 2018

v1.3.5

Oct 16, 2018

Changes in this version

type Client

+ func (c *Client) RenterSetRepairPathPost(siaPath, newPath string) (err error)

+ func (c *Client) WalletSignPost(txn types.Transaction, toSign []crypto.Hash) (wspr api.WalletSignPOSTResp, err error)

+ func (c *Client) WalletUnlockConditionsGet(addr types.UnlockHash) (wucg api.WalletUnlockConditionsGET, err error)

+ func (c *Client) WalletUnspentGet() (wug api.WalletUnspentGET, err error)

+ func (c *Client) WalletWatchAddPost(addrs []types.UnlockHash, unused bool) error

+ func (c *Client) WalletWatchGet() (wwg api.WalletWatchGET, err error)

+ func (c *Client) WalletWatchRemovePost(addrs []types.UnlockHash, unused bool) error

v1.3.4

Sep 5, 2018

Changes in this version

type Client

+ func (c *Client) RenterClearAllDownloadsPost() (err error)

+ func (c *Client) RenterClearDownloadsAfterPost(after time.Time) (err error)

+ func (c *Client) RenterClearDownloadsBeforePost(before time.Time) (err error)

+ func (c *Client) RenterClearDownloadsRangePost(after, before time.Time) (err error)

+ func (c *Client) RenterContractCancelPost(id types.FileContractID) error

+ func (c *Client) RenterExpiredContractsGet() (rc api.RenterContracts, err error)

+ func (c *Client) RenterInactiveContractsGet() (rc api.RenterContracts, err error)

v1.3.3

Jun 12, 2018

Changes in this version

+ const HostParamAcceptingContracts

+ const HostParamCollateral

+ const HostParamCollateralBudget

+ const HostParamMaxCollateral

+ const HostParamMaxDownloadBatchSize

+ const HostParamMaxDuration

+ const HostParamMaxReviseBatchSize

+ const HostParamMinContractPrice

+ const HostParamMinDownloadBandwidthPrice

+ const HostParamMinStoragePrice

+ const HostParamMinUploadBandwidthPrice

+ const HostParamNetAddress

+ const HostParamWindowSize

type Client

+ func (c *Client) ConsensusBlocksHeightGet(height types.BlockHeight) (cbg api.ConsensusBlocksGet, err error)

+ func (c *Client) ConsensusBlocksIDGet(id types.BlockID) (cbg api.ConsensusBlocksGet, err error)

+ func (c *Client) DaemonUpdateGet() (dig api.DaemonUpdateGet, err error)

+ func (c *Client) DaemonUpdatePost() (err error)

+ func (c *Client) GatewayDisconnectPost(address modules.NetAddress) (err error)

+ func (c *Client) HostAnnounceAddrPost(address modules.NetAddress) (err error)

+ func (c *Client) HostContractInfoGet() (cg api.ContractInfoGET, err error)

+ func (c *Client) HostDbAllGet() (hdag api.HostdbAllGET, err error)

+ func (c *Client) HostDbGet() (hdg api.HostdbGet, err error)

+ func (c *Client) HostDbHostsGet(pk types.SiaPublicKey) (hhg api.HostdbHostsGET, err error)

+ func (c *Client) HostEstimateScoreGet(param, value string) (eg api.HostEstimateScoreGET, err error)

+ func (c *Client) HostModifySettingPost(param HostParam, value interface{}) (err error)

+ func (c *Client) HostStorageFoldersRemovePost(path string) (err error)

+ func (c *Client) HostStorageFoldersResizePost(path string, size uint64) (err error)

+ func (c *Client) HostStorageGet() (sg api.StorageGET, err error)

+ func (c *Client) HostStorageSectorsDeletePost(root crypto.Hash) (err error)

+ func (c *Client) MinerGet() (mg api.MinerGET, err error)

+ func (c *Client) RenterCancelAllowance() (err error)

+ func (c *Client) RenterDownloadFullGet(siaPath, destination string, async bool) (err error)

+ func (c *Client) RenterFileGet(siaPath string) (rf api.RenterFile, err error)

+ func (c *Client) RenterGet() (rg api.RenterGET, err error)

+ func (c *Client) RenterPostAllowance(allowance modules.Allowance) (err error)

+ func (c *Client) RenterPostRateLimit(readBPS, writeBPS int64) (err error)

+ func (c *Client) RenterPricesGet() (rpg api.RenterPricesGET, err error)

+ func (c *Client) RenterRenamePost(siaPathOld, siaPathNew string) (err error)

+ func (c *Client) RenterSetStreamCacheSizePost(cacheSize uint64) (err error)

+ func (c *Client) RenterStreamGet(siaPath string) (resp []byte, err error)

+ func (c *Client) RenterStreamPartialGet(siaPath string, start, end uint64) (resp []byte, err error)

+ func (c *Client) RenterUploadDefaultPost(path, siaPath string) (err error)

+ func (c *Client) TransactionPoolFeeGet() (tfg api.TpoolFeeGET, err error)

+ func (c *Client) TransactionPoolRawPost(txn types.Transaction, parents types.Transaction) (err error)

+ func (c *Client) Wallet033xPost(path, password string) (err error)

+ func (c *Client) WalletAddressesGet() (wag api.WalletAddressesGET, err error)

+ func (c *Client) WalletChangePasswordPost(currentPassword, newPassword string) (err error)

+ func (c *Client) WalletInitSeedPost(seed, password string, force bool) (err error)

+ func (c *Client) WalletLockPost() (err error)

+ func (c *Client) WalletSeedPost(seed, password string) (err error)

+ func (c *Client) WalletSeedsGet() (wsg api.WalletSeedsGET, err error)

+ func (c *Client) WalletSiafundsPost(amount types.Currency, destination types.UnlockHash) (wsp api.WalletSiafundsPOST, err error)

+ func (c *Client) WalletSiagKeyPost(keyfiles, password string) (err error)

+ func (c *Client) WalletSweepPost(seed string) (wsp api.WalletSweepPOST, err error)

+ func (c *Client) WalletTransactionGet(id types.TransactionID) (wtg api.WalletTransactionGETid, err error)

+ type HostParam string

v1.3.2

Mar 13, 2018

Changes in this version

+ var ErrPeerExists = errors.New("already connected to this peer")

+ type Client struct

+ Address string

+ Password string

+ UserAgent string

+ func New(address string) *Client

+ func (c *Client) ConsensusGet() (cg api.ConsensusGET, err error)

+ func (c *Client) DaemonStopGet() (err error)

+ func (c *Client) DaemonVersionGet() (dvg api.DaemonVersionGet, err error)

+ func (c *Client) GatewayConnectPost(address modules.NetAddress) (err error)

+ func (c *Client) GatewayGet() (gwg api.GatewayGET, err error)

+ func (c *Client) HostAcceptingContractsPost(acceptingContracts bool) (err error)

+ func (c *Client) HostAnnouncePost() (err error)

+ func (c *Client) HostDbActiveGet() (hdag api.HostdbActiveGET, err error)

+ func (c *Client) HostGet() (hg api.HostGET, err error)

+ func (c *Client) HostStorageFoldersAddPost(path string, size uint64) (err error)

+ func (c *Client) MinerHeaderGet() (target types.Target, bh types.BlockHeader, err error)

+ func (c *Client) MinerHeaderPost(bh types.BlockHeader) (err error)

+ func (c *Client) MinerStartGet() (err error)

+ func (c *Client) MinerStopGet() (err error)

+ func (c *Client) NewRequest(method, resource string, body io.Reader) (*http.Request, error)

+ func (c *Client) RenterContractsGet() (rc api.RenterContracts, err error)

+ func (c *Client) RenterDeletePost(siaPath string) (err error)

+ func (c *Client) RenterDownloadGet(siaPath, destination string, offset, length uint64, async bool) (err error)

+ func (c *Client) RenterDownloadHTTPResponseGet(siaPath string, offset, length uint64) (resp []byte, err error)

+ func (c *Client) RenterDownloadsGet() (rdq api.RenterDownloadQueue, err error)

+ func (c *Client) RenterFilesGet() (rf api.RenterFiles, err error)

+ func (c *Client) RenterPost(allowance modules.Allowance) (err error)

+ func (c *Client) RenterUploadPost(path, siaPath string, dataPieces, parityPieces uint64) (err error)

+ func (c *Client) WalletAddressGet() (wag api.WalletAddressGET, err error)

+ func (c *Client) WalletGet() (wg api.WalletGET, err error)

+ func (c *Client) WalletInitPost(password string, force bool) (wip api.WalletInitPOST, err error)

+ func (c *Client) WalletSiacoinsMultiPost(outputs []types.SiacoinOutput) (wsp api.WalletSiacoinsPOST, err error)

+ func (c *Client) WalletSiacoinsPost(amount types.Currency, destination types.UnlockHash) (wsp api.WalletSiacoinsPOST, err error)

+ func (c *Client) WalletTransactionsGet(startHeight types.BlockHeight, endHeight types.BlockHeight) (wtg api.WalletTransactionsGET, err error)

+ func (c *Client) WalletUnlockPost(password string) (err error)

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