api

type API ¶ added in v1.0.3

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(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

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

type ActiveHosts ¶

type ActiveHosts struct {
	Hosts []modules.HostDBEntry `json:"hosts"`
}

ActiveHosts lists active hosts on the network.

type AllHosts ¶ added in v1.0.1

type AllHosts struct {
	Hosts []modules.HostDBEntry `json:"hosts"`
}

AllHosts lists all hosts that the renter is aware of.

type Client ¶ added in v1.0.3

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

Client holds fields to make requests to a Sia API.

func NewClient(address string, password string) *Client

func (c *Client) Get(resource string, obj interface{}) error

func (c *Client) Post(resource string, data string, obj interface{}) error

type ConsensusGET ¶ added in v1.0.0

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

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

type Error ¶ added in v1.0.0

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 (err Error) Error() string

type ExplorerBlock ¶ added in v1.0.0

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 ¶ added in v1.0.0

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

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

type ExplorerGET ¶ added in v1.0.0

type ExplorerGET struct {
	modules.BlockFacts
}

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

type ExplorerHashGET ¶ added in v1.0.0

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 ¶ added in v1.0.0

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 GatewayGET ¶ added in v1.0.1

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 HostGET ¶ added in v1.0.0

type HostGET struct {
	ExternalSettings modules.HostExternalSettings `json:"externalsettings"`
	FinancialMetrics modules.HostFinancialMetrics `json:"financialmetrics"`
	InternalSettings modules.HostInternalSettings `json:"internalsettings"`
	NetworkMetrics   modules.HostNetworkMetrics   `json:"networkmetrics"`
}

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

type MinerGET ¶ added in v1.0.0

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 ¶ added in v1.0.0

type RenterContract struct {
	EndHeight   types.BlockHeight    `json:"endheight"`
	ID          types.FileContractID `json:"id"`
	NetAddress  modules.NetAddress   `json:"netaddress"`
	RenterFunds types.Currency       `json:"renterfunds"`
	Size        uint64               `json:"size"`
}

RenterContract represents a contract formed by the renter.

type RenterContracts ¶ added in v1.0.0

type RenterContracts struct {
	Contracts []RenterContract `json:"contracts"`
}

RenterContracts contains the renter's contracts.

type RenterDownloadQueue ¶ added in v1.0.0

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

DownloadQueue contains the renter's download queue.

type RenterFiles ¶ added in v1.0.0

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

RenterFiles lists the files known to the renter.

type RenterGET ¶ added in v1.0.0

type RenterGET struct {
	Settings         modules.RenterSettings         `json:"settings"`
	FinancialMetrics modules.RenterFinancialMetrics `json:"financialmetrics"`
}

RenterGET contains various renter metrics.

type RenterLoad ¶ added in v1.0.0

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

RenterLoad lists files that were loaded into the renter.

type RenterShareASCII ¶ added in v1.0.0

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

RenterShareASCII contains an ASCII-encoded .sia file.

type StorageGET ¶ added in v1.0.0

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 TransactionPoolGET ¶ added in v1.0.0

type TransactionPoolGET struct {
	Transactions []types.Transaction `json:"transactions"`
}

type WalletAddressGET ¶ added in v1.0.0

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

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

type WalletAddressesGET ¶ added in v1.0.0

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 ¶ added in v1.0.0

type WalletGET struct {
	Encrypted bool `json:"encrypted"`
	Unlocked  bool `json:"unlocked"`

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

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

WalletGET contains general information about the wallet.

type WalletInitPOST ¶ added in v1.0.0

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

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

type WalletSeedsGET ¶ added in v1.0.0

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 ¶ added in v1.0.0

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

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

type WalletSiafundsPOST ¶ added in v1.0.0

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

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

type WalletTransactionGETid ¶ added in v1.0.0

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

WalletTransactionGETid contains the transaction returned by a call to /wallet/transaction/$(id)

type WalletTransactionsGET ¶ added in v1.0.0

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 ¶ added in v1.0.0

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)