Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.2.3

Dec 11, 2018

Changes in this version

type DownloadInfo

+ HyperspacePath string

v0.2.2

Oct 28, 2018

v0.2.1

Oct 28, 2018

v0.2.0

Oct 3, 2018

Changes in this version

+ const MaxBlocksRequest

+ const WriteTimeout

+ var Upgrader = websocket.Upgrader

+ 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 HttpPOSTJSON(url string, data 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, error)

+ func (api *API) ProcessConsensusChange(cc modules.ConsensusChange)

+ func (api *API) ReceiveUpdatedUnconfirmedTransactions(diff *modules.TransactionPoolDiff)

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

+ type ConsensusBlock struct

+ BlockHeader types.BlockHeader

+ BlockHeight types.BlockHeight

+ BlockID types.BlockID

+ Difficulty types.Currency

+ EstimatedHashrate types.Currency

+ MinerPayouts map[string]types.SiacoinOutput

+ Target types.Target

+ TotalCoins types.Currency

+ Transactions map[string]ConsensusTransaction

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

+ ArbitraryData [][]byte

+ FileContractRevisions []types.FileContractRevision

+ FileContracts []ConsensusBlocksGetFileContract

+ ID types.TransactionID

+ MinerFees []types.Currency

+ SiacoinInputs []types.SiacoinInput

+ SiacoinOutputs []ConsensusBlocksGetSiacoinOutput

+ StorageProofs []types.StorageProof

+ TransactionSignatures []types.TransactionSignature

+ type ConsensusFileContract struct

+ FileMerkleRoot crypto.Hash

+ FileSize uint64

+ MissedProofOutputs map[string]types.SiacoinOutput

+ Payout types.Currency

+ RevisionNumber uint64

+ UnlockHash types.UnlockHash

+ ValidProofOutputs map[string]types.SiacoinOutput

+ WindowEnd types.BlockHeight

+ WindowStart types.BlockHeight

+ type ConsensusFileContractRevision struct

+ NewFileMerkleRoot crypto.Hash

+ NewFileSize uint64

+ NewMissedProofOutputs map[string]types.SiacoinOutput

+ NewRevisionNumber uint64

+ NewUnlockHash types.UnlockHash

+ NewValidProofOutputs map[string]types.SiacoinOutput

+ NewWindowEnd types.BlockHeight

+ NewWindowStart types.BlockHeight

+ ParentID types.FileContractID

+ UnlockConditions types.UnlockConditions

+ type ConsensusGET struct

+ CurrentBlock types.BlockID

+ Difficulty types.Currency

+ Height types.BlockHeight

+ Synced bool

+ Target types.Target

+ type ConsensusHeadersGET struct

+ BlockID types.BlockID

+ type ConsensusTransaction struct

+ ArbitraryData [][]byte

+ FileContractRevisions map[string]ConsensusFileContractRevision

+ FileContracts map[string]ConsensusFileContract

+ MinerFees map[string]types.Currency

+ SiacoinInputs map[string]types.SiacoinInput

+ SiacoinOutputs map[string]types.SiacoinOutput

+ StorageProofs map[string]types.StorageProof

+ TransactionSignatures map[string]types.TransactionSignature

+ type ContractInfoGET struct

+ Contracts []modules.StorageObligation

+ type DaemonUpdateGet struct

+ Available bool

+ Version string

+ 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

+ StartTimeUnix int64

+ 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

+ Blocks []ExplorerBlock

+ type ExplorerConsensusChange struct

+ AppliedBlocks []ExplorerBlock

+ RevertedBlocks []types.BlockID

+ type ExplorerHashGET struct

+ Block *ExplorerBlock

+ Blocks []ExplorerBlock

+ HashType string

+ Transaction *ExplorerTransaction

+ Transactions []ExplorerTransaction

+ type ExplorerPendingBlockGET struct

+ PendingBlock PendingExplorerBlock

+ 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

+ StorageProofOutputIDs [][]types.SiacoinOutputID

+ StorageProofOutputs [][]types.SiacoinOutput

+ type ExplorerUnconfirmedTransactionChange struct

+ AppliedTransactions []ExplorerTransaction

+ RevertedTransactions []types.TransactionID

+ type ExtendedHostDBEntry struct

+ PublicKeyString string

+ ScoreBreakdown modules.HostScoreBreakdown

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

+ InitialScanComplete bool

+ type HostdbHostsGET struct

+ Entry ExtendedHostDBEntry

+ ScoreBreakdown modules.HostScoreBreakdown

+ type MinerGET struct

+ BlocksMined int

+ CPUHashrate int

+ CPUMining bool

+ StaleBlocksMined int

+ type MiningPoolBlockClientInfo struct

+ ClientName string

+ ClientPercentage float64

+ ClientReward string

+ type MiningPoolBlockInfo struct

+ BlockHeight uint64

+ BlockNumber uint64

+ BlockReward string

+ BlockStatus string

+ BlockTime time.Time

+ type MiningPoolClientInfo struct

+ Balance string

+ BlocksMined uint64

+ ClientName string

+ Workers []PoolWorkerInfo

+ type MiningPoolClientTransaction struct

+ BalanceChange string

+ Memo string

+ TxTime time.Time

+ type MiningPoolClientsInfo struct

+ Clients []MiningPoolClientInfo

+ NumberOfClients uint64

+ NumberOfWorkers uint64

+ type MiningPoolConfig struct

+ DBConnection string

+ Name string

+ NetworkPort int

+ OperatorWallet types.UnlockHash

+ PoolID uint64

+ PoolWallet types.UnlockHash

+ type MiningPoolGET struct

+ BlocksMined int

+ PoolHashrate int

+ type PendingExplorerBlock struct

+ Transactions []ExplorerTransaction

+ type PoolWorkerInfo struct

+ BlocksFound uint64

+ CumulativeDifficulty float64

+ CurrentDifficulty float64

+ InvalidSharesThisBlock uint64

+ LastShareTime time.Time

+ SharesThisBlock uint64

+ StaleSharesThisBlock uint64

+ WorkerName string

+ 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

+ ActiveContracts []RenterContract

+ Contracts []RenterContract

+ ExpiredContracts []RenterContract

+ InactiveContracts []RenterContract

+ type RenterDownloadQueue struct

+ Downloads []DownloadInfo

+ type RenterFile struct

+ File modules.FileInfo

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

+ Hashrate float64

+ Mining bool

+ Submissions uint64

+ type Subscriber struct

+ func (s *Subscriber) SocketWriter()

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

+ Address types.UnlockHash

+ type WalletAddressesGET struct

+ Addresses []types.UnlockHash

+ type WalletBuildTransactionGET struct

+ Transaction types.Transaction

+ type WalletGET struct

+ ConfirmedSiacoinBalance types.Currency

+ DustThreshold types.Currency

+ Encrypted bool

+ Height types.BlockHeight

+ Rescanning bool

+ SiacoinClaimBalance 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 WalletSignPOSTParams struct

+ ToSign []crypto.Hash

+ Transaction types.Transaction

+ type WalletSignPOSTResp struct

+ Transaction types.Transaction

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

+ UnlockConditions types.UnlockConditions

+ type WalletUnlockConditionsPOSTParams struct

+ UnlockConditions types.UnlockConditions

+ type WalletUnspentGET struct

+ Outputs []modules.UnspentOutput

+ type WalletVerifyAddressGET struct

+ Valid bool

+ type WalletWatchGET struct

+ Addresses []types.UnlockHash

+ type WalletWatchPOST struct

+ Addresses []types.UnlockHash

+ Remove bool

+ Unused bool

+ type WebsocketHub struct

+ func (h *WebsocketHub) StartWebsocketHub()