api

package
v1.3.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 12, 2018 License: MIT Imports: 19 Imported by: 82

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HttpGET 

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

HttpGET is a utility function for making http get requests to sia with a whitelisted user-agent. A non-2xx response does not return an error.

func HttpGETAuthenticated 

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

HttpGETAuthenticated is a utility function for making authenticated http get requests to sia with a whitelisted user-agent and the supplied password. A non-2xx response does not return an error.

func HttpPOST 

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

HttpPOST is a utility function for making post requests to sia with a whitelisted user-agent. A non-2xx response does not return an error.

func HttpPOSTAuthenticated 

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

HttpPOSTAuthenticated is a utility function for making authenticated http post requests to sia with a whitelisted user-agent and the supplied password. A non-2xx response does not return an error.

func RequirePassword 

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

RequirePassword is middleware that requires a request to authenticate with a password using HTTP basic auth. Usernames are ignored. Empty passwords indicate no authentication is required.

func RequireUserAgent 

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

RequireUserAgent is middleware that requires all requests to set a UserAgent that contains the specified string.

func UnrecognizedCallHandler 

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

UnrecognizedCallHandler handles calls to unknown pages (404).

func WriteError 

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

WriteError an error to the API caller.

func WriteJSON 

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

WriteJSON writes the object to the ResponseWriter. If the encoding fails, an error is written instead. The Content-Type of the response header is set accordingly.

func WriteSuccess 

func WriteSuccess(w http.ResponseWriter)

WriteSuccess writes the HTTP header with status 204 No Content to the ResponseWriter. WriteSuccess should only be used to indicate that the requested action succeeded AND there is no data to return.

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

API encapsulates a collection of modules and implements a http.Handler to access their methods.

func New 

func New(requiredUserAgent string, requiredPassword string, cs modules.ConsensusSet, e modules.Explorer, g modules.Gateway, h modules.Host, m modules.Miner, r modules.Renter, tp modules.TransactionPool, w modules.Wallet) *API

New creates a new Sia API from the provided modules. The API will require authentication using HTTP basic auth for certain endpoints of the supplied password is not the empty string. Usernames are ignored for authentication.

func (*API) ServeHTTP 

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

api.ServeHTTP implements the http.Handler interface.

type ConsensusBlocksGet added in v1.3.3 

type ConsensusBlocksGet struct {
	ID           types.BlockID           `json:"id"`
	Height       types.BlockHeight       `json:"height"`
	ParentID     types.BlockID           `json:"parentid"`
	Nonce        types.BlockNonce        `json:"nonce"`
	Timestamp    types.Timestamp         `json:"timestamp"`
	MinerPayouts []types.SiacoinOutput   `json:"minerpayouts"`
	Transactions []ConsensusBlocksGetTxn `json:"transactions"`
}

ConsensusBlocksGet contains all fields of a types.Block and additional fields for ID and Height.

type ConsensusBlocksGetFileContract added in v1.3.3 

type ConsensusBlocksGetFileContract struct {
	ID                 types.FileContractID              `json:"id"`
	FileSize           uint64                            `json:"filesize"`
	FileMerkleRoot     crypto.Hash                       `json:"filemerkleroot"`
	WindowStart        types.BlockHeight                 `json:"windowstart"`
	WindowEnd          types.BlockHeight                 `json:"windowend"`
	Payout             types.Currency                    `json:"payout"`
	ValidProofOutputs  []ConsensusBlocksGetSiacoinOutput `json:"validproofoutputs"`
	MissedProofOutputs []ConsensusBlocksGetSiacoinOutput `json:"missedproofoutputs"`
	UnlockHash         types.UnlockHash                  `json:"unlockhash"`
	RevisionNumber     uint64                            `json:"revisionnumber"`
}

ConsensusBlocksGetFileContract contains all fields of a types.FileContract and an additional ID field.

type ConsensusBlocksGetSiacoinOutput added in v1.3.3 

type ConsensusBlocksGetSiacoinOutput struct {
	ID         types.SiacoinOutputID `json:"id"`
	Value      types.Currency        `json:"value"`
	UnlockHash types.UnlockHash      `json:"unlockhash"`
}

ConsensusBlocksGetSiacoinOutput contains all fields of a types.SiacoinOutput and an additional ID field.

type ConsensusBlocksGetSiafundOutput added in v1.3.3 

type ConsensusBlocksGetSiafundOutput struct {
	ID         types.SiafundOutputID `json:"id"`
	Value      types.Currency        `json:"value"`
	UnlockHash types.UnlockHash      `json:"unlockhash"`
}

ConsensusBlocksGetSiafundOutput contains all fields of a types.SiafundOutput and an additional ID field.

type ConsensusBlocksGetTxn added in v1.3.3 

type ConsensusBlocksGetTxn struct {
	ID                    types.TransactionID               `json:"id"`
	SiacoinInputs         []types.SiacoinInput              `json:"siacoininputs"`
	SiacoinOutputs        []ConsensusBlocksGetSiacoinOutput `json:"siacoinoutputs"`
	FileContracts         []ConsensusBlocksGetFileContract  `json:"filecontracts"`
	FileContractRevisions []types.FileContractRevision      `json:"filecontractrevisions"`
	StorageProofs         []types.StorageProof              `json:"storageproofs"`
	SiafundInputs         []types.SiafundInput              `json:"siafundinputs"`
	SiafundOutputs        []ConsensusBlocksGetSiafundOutput `json:"siafundoutputs"`
	MinerFees             []types.Currency                  `json:"minerfees"`
	ArbitraryData         [][]byte                          `json:"arbitrarydata"`
	TransactionSignatures []types.TransactionSignature      `json:"transactionsignatures"`
}

ConsensusBlocksGetTxn contains all fields of a types.Transaction and an additional ID field.

type ConsensusGET 

type ConsensusGET struct {
	Synced       bool              `json:"synced"`
	Height       types.BlockHeight `json:"height"`
	CurrentBlock types.BlockID     `json:"currentblock"`
	Target       types.Target      `json:"target"`
	Difficulty   types.Currency    `json:"difficulty"`
}

ConsensusGET contains general information about the consensus set, with tags to support idiomatic json encodings.

type ConsensusHeadersGET added in v1.3.3 

type ConsensusHeadersGET struct {
	BlockID types.BlockID `json:"blockid"`
}

ConsensusHeadersGET contains information from a blocks header.

type ContractInfoGET added in v1.3.3 

type ContractInfoGET struct {
	Contracts []modules.StorageObligation `json:"contracts"`
}

ContractInfoGET contains the information that is returned after a GET request to /host/contracts - information for the host about stored obligations.

type DaemonUpdateGet added in v1.3.3 

type DaemonUpdateGet struct {
	Available bool   `json:"available"`
	Version   string `json:"version"`
}

DaemonUpdateGet contains information about a potential available update for the daemon.

type DaemonVersionGet 

type DaemonVersionGet struct {
	Version     string
	GitRevision string
	BuildTime   string
}

DaemonVersionGet contains information about the running daemon's version.

type DownloadInfo 

type DownloadInfo struct {
	Destination     string `json:"destination"`     // The destination of the download.
	DestinationType string `json:"destinationtype"` // Can be "file", "memory buffer", or "http stream".
	Filesize        uint64 `json:"filesize"`        // DEPRECATED. Same as 'Length'.
	Length          uint64 `json:"length"`          // The length requested for the download.
	Offset          uint64 `json:"offset"`          // The offset within the siafile requested for the download.
	SiaPath         string `json:"siapath"`         // The siapath of the file used for the download.

	Completed            bool      `json:"completed"`            // Whether or not the download has completed.
	EndTime              time.Time `json:"endtime"`              // The time when the download fully completed.
	Error                string    `json:"error"`                // Will be the empty string unless there was an error.
	Received             uint64    `json:"received"`             // Amount of data confirmed and decoded.
	StartTime            time.Time `json:"starttime"`            // The time when the download was started.
	StartTimeUnix        int64     `json:"starttimeunix"`        // The time when the download was started in unix format.
	TotalDataTransferred uint64    `json:"totaldatatransferred"` // The total amount of data transferred, including negotiation, overdrive etc.
}

DownloadInfo contains all client-facing information of a file.

type Error 

type Error struct {
	// Message describes the error in English. Typically it is set to
	// `err.Error()`. This field is required.
	Message string `json:"message"`
}

Error is a type that is encoded as JSON and returned in an API response in the event of an error. Only the Message field is required. More fields may be added to this struct in the future for better error reporting.

func (Error) Error 

func (err Error) Error() string

Error implements the error interface for the Error type. It returns only the Message field.

type ExplorerBlock 

type ExplorerBlock struct {
	MinerPayoutIDs []types.SiacoinOutputID `json:"minerpayoutids"`
	Transactions   []ExplorerTransaction   `json:"transactions"`
	RawBlock       types.Block             `json:"rawblock"`

	modules.BlockFacts
}

ExplorerBlock is a block with some extra information such as the id and height. This information is provided for programs that may not be complex enough to compute the ID on their own.

type ExplorerBlockGET 

type ExplorerBlockGET struct {
	Block ExplorerBlock `json:"block"`
}

ExplorerBlockGET is the object returned by a GET request to /explorer/block.

type ExplorerGET 

type ExplorerGET struct {
	modules.BlockFacts
}

ExplorerGET is the object returned as a response to a GET request to /explorer.

type ExplorerHashGET 

type ExplorerHashGET struct {
	HashType     string                `json:"hashtype"`
	Block        ExplorerBlock         `json:"block"`
	Blocks       []ExplorerBlock       `json:"blocks"`
	Transaction  ExplorerTransaction   `json:"transaction"`
	Transactions []ExplorerTransaction `json:"transactions"`
}

ExplorerHashGET is the object returned as a response to a GET request to /explorer/hash. The HashType will indicate whether the hash corresponds to a block id, a transaction id, a siacoin output id, a file contract id, or a siafund output id. In the case of a block id, 'Block' will be filled out and all the rest of the fields will be blank. In the case of a transaction id, 'Transaction' will be filled out and all the rest of the fields will be blank. For everything else, 'Transactions' and 'Blocks' will/may be filled out and everything else will be blank.

type ExplorerTransaction 

type ExplorerTransaction struct {
	ID             types.TransactionID `json:"id"`
	Height         types.BlockHeight   `json:"height"`
	Parent         types.BlockID       `json:"parent"`
	RawTransaction types.Transaction   `json:"rawtransaction"`

	SiacoinInputOutputs                      []types.SiacoinOutput     `json:"siacoininputoutputs"` // the outputs being spent
	SiacoinOutputIDs                         []types.SiacoinOutputID   `json:"siacoinoutputids"`
	FileContractIDs                          []types.FileContractID    `json:"filecontractids"`
	FileContractValidProofOutputIDs          [][]types.SiacoinOutputID `json:"filecontractvalidproofoutputids"`          // outer array is per-contract
	FileContractMissedProofOutputIDs         [][]types.SiacoinOutputID `json:"filecontractmissedproofoutputids"`         // outer array is per-contract
	FileContractRevisionValidProofOutputIDs  [][]types.SiacoinOutputID `json:"filecontractrevisionvalidproofoutputids"`  // outer array is per-revision
	FileContractRevisionMissedProofOutputIDs [][]types.SiacoinOutputID `json:"filecontractrevisionmissedproofoutputids"` // outer array is per-revision
	StorageProofOutputIDs                    [][]types.SiacoinOutputID `json:"storageproofoutputids"`                    // outer array is per-payout
	StorageProofOutputs                      [][]types.SiacoinOutput   `json:"storageproofoutputs"`                      // outer array is per-payout
	SiafundInputOutputs                      []types.SiafundOutput     `json:"siafundinputoutputs"`                      // the outputs being spent
	SiafundOutputIDs                         []types.SiafundOutputID   `json:"siafundoutputids"`
	SiafundClaimOutputIDs                    []types.SiacoinOutputID   `json:"siafundclaimoutputids"`
}

ExplorerTransaction is a transcation with some extra information such as the parent block. This information is provided for programs that may not be complex enough to compute the extra information on their own.

type ExtendedHostDBEntry 

type ExtendedHostDBEntry struct {
	modules.HostDBEntry
	PublicKeyString string `json:"publickeystring"`
}

ExtendedHostDBEntry is an extension to modules.HostDBEntry that includes the string representation of the public key, otherwise presented as two fields, a string and a base64 encoded byte slice.

type GatewayGET 

type GatewayGET struct {
	NetAddress modules.NetAddress `json:"netaddress"`
	Peers      []modules.Peer     `json:"peers"`
}

GatewayGET contains the fields returned by a GET call to "/gateway".

type HostEstimateScoreGET 

type HostEstimateScoreGET struct {
	EstimatedScore types.Currency `json:"estimatedscore"`
	ConversionRate float64        `json:"conversionrate"`
}

HostEstimateScoreGET contains the information that is returned from a /host/estimatescore call.

type HostGET 

type HostGET struct {
	ExternalSettings     modules.HostExternalSettings     `json:"externalsettings"`
	FinancialMetrics     modules.HostFinancialMetrics     `json:"financialmetrics"`
	InternalSettings     modules.HostInternalSettings     `json:"internalsettings"`
	NetworkMetrics       modules.HostNetworkMetrics       `json:"networkmetrics"`
	ConnectabilityStatus modules.HostConnectabilityStatus `json:"connectabilitystatus"`
	WorkingStatus        modules.HostWorkingStatus        `json:"workingstatus"`
}

HostGET contains the information that is returned after a GET request to /host - a bunch of information about the status of the host.

type HostdbActiveGET 

type HostdbActiveGET struct {
	Hosts []ExtendedHostDBEntry `json:"hosts"`
}

HostdbActiveGET lists active hosts on the network.

type HostdbAllGET 

type HostdbAllGET struct {
	Hosts []ExtendedHostDBEntry `json:"hosts"`
}

HostdbAllGET lists all hosts that the renter is aware of.

type HostdbGet added in v1.3.3 

type HostdbGet struct {
	InitialScanComplete bool `json:"initialscancomplete"`
}

HostdbGet holds information about the hostdb.

type HostdbHostsGET 

type HostdbHostsGET struct {
	Entry          ExtendedHostDBEntry        `json:"entry"`
	ScoreBreakdown modules.HostScoreBreakdown `json:"scorebreakdown"`
}

HostdbHostsGET lists detailed statistics for a particular host, selected by pubkey.

type MinerGET 

type MinerGET struct {
	BlocksMined      int  `json:"blocksmined"`
	CPUHashrate      int  `json:"cpuhashrate"`
	CPUMining        bool `json:"cpumining"`
	StaleBlocksMined int  `json:"staleblocksmined"`
}

MinerGET contains the information that is returned after a GET request to /miner.

type RenterContract 

type RenterContract struct {
	// Amount of contract funds that have been spent on downloads.
	DownloadSpending types.Currency `json:"downloadspending"`
	// Block height that the file contract ends on.
	EndHeight types.BlockHeight `json:"endheight"`
	// Fees paid in order to form the file contract.
	Fees types.Currency `json:"fees"`
	// Public key of the host the contract was formed with.
	HostPublicKey types.SiaPublicKey `json:"hostpublickey"`
	// ID of the file contract.
	ID types.FileContractID `json:"id"`
	// A signed transaction containing the most recent contract revision.
	LastTransaction types.Transaction `json:"lasttransaction"`
	// Address of the host the file contract was formed with.
	NetAddress modules.NetAddress `json:"netaddress"`
	// Remaining funds left for the renter to spend on uploads & downloads.
	RenterFunds types.Currency `json:"renterfunds"`
	// Size of the file contract, which is typically equal to the number of
	// bytes that have been uploaded to the host.
	Size uint64 `json:"size"`
	// Block height that the file contract began on.
	StartHeight types.BlockHeight `json:"startheight"`
	// Amount of contract funds that have been spent on storage.
	StorageSpending types.Currency `json:"storagespending"`
	// DEPRECATED: This is the exact same value as StorageSpending, but it has
	// incorrect capitalization. This was fixed in 1.3.2, but this field is kept
	// to preserve backwards compatibility on clients who depend on the
	// incorrect capitalization. This field will be removed in the future, so
	// clients should switch to the StorageSpending field (above) with the
	// correct lowercase name.
	StorageSpendingDeprecated types.Currency `json:"StorageSpending"`
	// Total cost to the wallet of forming the file contract.
	TotalCost types.Currency `json:"totalcost"`
	// Amount of contract funds that have been spent on uploads.
	UploadSpending types.Currency `json:"uploadspending"`
	// Signals if contract is good for uploading data
	GoodForUpload bool `json:"goodforupload"`
	// Signals if contract is good for a renewal
	GoodForRenew bool `json:"goodforrenew"`
}

RenterContract represents a contract formed by the renter.

type RenterContracts 

type RenterContracts struct {
	Contracts         []RenterContract `json:"contracts"`
	ActiveContracts   []RenterContract `json:"activecontracts"`
	InactiveContracts []RenterContract `json:"inactivecontracts"`
	ExpiredContracts  []RenterContract `json:"expiredcontracts"`
}

RenterContracts contains the renter's contracts.

type RenterDownloadQueue 

type RenterDownloadQueue struct {
	Downloads []DownloadInfo `json:"downloads"`
}

RenterDownloadQueue contains the renter's download queue.

type RenterFile added in v1.3.3 

type RenterFile struct {
	File modules.FileInfo `json:"file"`
}

RenterFile lists the file queried.

type RenterFiles 

type RenterFiles struct {
	Files []modules.FileInfo `json:"files"`
}

RenterFiles lists the files known to the renter.

type RenterGET 

type RenterGET struct {
	Settings         modules.RenterSettings     `json:"settings"`
	FinancialMetrics modules.ContractorSpending `json:"financialmetrics"`
	CurrentPeriod    types.BlockHeight          `json:"currentperiod"`
}

RenterGET contains various renter metrics.

type RenterLoad 

type RenterLoad struct {
	FilesAdded []string `json:"filesadded"`
}

RenterLoad lists files that were loaded into the renter.

type RenterPricesGET 

type RenterPricesGET struct {
	modules.RenterPriceEstimation
}

RenterPricesGET lists the data that is returned when a GET call is made to /renter/prices.

type RenterShareASCII 

type RenterShareASCII struct {
	ASCIIsia string `json:"asciisia"`
}

RenterShareASCII contains an ASCII-encoded .sia file.

type StorageGET 

type StorageGET struct {
	Folders []modules.StorageFolderMetadata `json:"folders"`
}

StorageGET contains the information that is returned after a GET request to /host/storage - a bunch of information about the status of storage management on the host.

type TpoolConfirmedGET 

type TpoolConfirmedGET struct {
	Confirmed bool `json:"confirmed"`
}

TpoolConfirmedGET contains information about whether or not the transaction has been seen on the blockhain

type TpoolFeeGET 

type TpoolFeeGET struct {
	Minimum types.Currency `json:"minimum"`
	Maximum types.Currency `json:"maximum"`
}

TpoolFeeGET contains the current estimated fee

type TpoolRawGET 

type TpoolRawGET struct {
	ID          types.TransactionID `json:"id"`
	Parents     []byte              `json:"parents"`
	Transaction []byte              `json:"transaction"`
}

TpoolRawGET contains the requested transaction encoded to the raw format, along with the id of that transaction.

type WalletAddressGET 

type WalletAddressGET struct {
	Address types.UnlockHash `json:"address"`
}

WalletAddressGET contains an address returned by a GET call to /wallet/address.

type WalletAddressesGET 

type WalletAddressesGET struct {
	Addresses []types.UnlockHash `json:"addresses"`
}

WalletAddressesGET contains the list of wallet addresses returned by a GET call to /wallet/addresses.

type WalletGET 

type WalletGET struct {
	Encrypted  bool              `json:"encrypted"`
	Height     types.BlockHeight `json:"height"`
	Rescanning bool              `json:"rescanning"`
	Unlocked   bool              `json:"unlocked"`

	ConfirmedSiacoinBalance     types.Currency `json:"confirmedsiacoinbalance"`
	UnconfirmedOutgoingSiacoins types.Currency `json:"unconfirmedoutgoingsiacoins"`
	UnconfirmedIncomingSiacoins types.Currency `json:"unconfirmedincomingsiacoins"`

	SiacoinClaimBalance types.Currency `json:"siacoinclaimbalance"`
	SiafundBalance      types.Currency `json:"siafundbalance"`

	DustThreshold types.Currency `json:"dustthreshold"`
}

WalletGET contains general information about the wallet.

type WalletInitPOST 

type WalletInitPOST struct {
	PrimarySeed string `json:"primaryseed"`
}

WalletInitPOST contains the primary seed that gets generated during a POST call to /wallet/init.

type WalletSeedsGET 

type WalletSeedsGET struct {
	PrimarySeed        string   `json:"primaryseed"`
	AddressesRemaining int      `json:"addressesremaining"`
	AllSeeds           []string `json:"allseeds"`
}

WalletSeedsGET contains the seeds used by the wallet.

type WalletSiacoinsPOST 

type WalletSiacoinsPOST struct {
	TransactionIDs []types.TransactionID `json:"transactionids"`
}

WalletSiacoinsPOST contains the transaction sent in the POST call to /wallet/siacoins.

type WalletSiafundsPOST 

type WalletSiafundsPOST struct {
	TransactionIDs []types.TransactionID `json:"transactionids"`
}

WalletSiafundsPOST contains the transaction sent in the POST call to /wallet/siafunds.

type WalletSweepPOST 

type WalletSweepPOST struct {
	Coins types.Currency `json:"coins"`
	Funds types.Currency `json:"funds"`
}

WalletSweepPOST contains the coins and funds returned by a call to /wallet/sweep.

type WalletTransactionGETid 

type WalletTransactionGETid struct {
	Transaction modules.ProcessedTransaction `json:"transaction"`
}

WalletTransactionGETid contains the transaction returned by a call to /wallet/transaction/:id

type WalletTransactionsGET 

type WalletTransactionsGET struct {
	ConfirmedTransactions   []modules.ProcessedTransaction `json:"confirmedtransactions"`
	UnconfirmedTransactions []modules.ProcessedTransaction `json:"unconfirmedtransactions"`
}

WalletTransactionsGET contains the specified set of confirmed and unconfirmed transactions.

type WalletTransactionsGETaddr 

type WalletTransactionsGETaddr struct {
	ConfirmedTransactions   []modules.ProcessedTransaction `json:"confirmedtransactions"`
	UnconfirmedTransactions []modules.ProcessedTransaction `json:"unconfirmedtransactions"`
}

WalletTransactionsGETaddr contains the set of wallet transactions relevant to the input address provided in the call to /wallet/transaction/:addr

type WalletVerifyAddressGET 

type WalletVerifyAddressGET struct {
	Valid bool `json:"valid"`
}

WalletVerifyAddressGET contains a bool indicating if the address passed to /wallet/verify/address/:addr is a valid address.

Source Files

View all Source files

Directories

Path Synopsis
Package server provides a server that can wrap a node and serve an http api for interacting with the node.
 Package server provides a server that can wrap a node and serve an http api for interacting with the node.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.