api

package

Go to main page

Versions in this module

v0

v0.11.5

May 13, 2024

v0.11.4

May 9, 2024

v0.11.3

May 7, 2024

v0.11.2

May 5, 2024

v0.11.1

Apr 26, 2024

v0.11.0

Apr 26, 2024

Changes in this version

+ type ConsensusTipResponse struct

+ BlockID types.BlockID

+ Height uint64

+ Synced bool

+ type HostdbGET struct

+ BlockHeight uint64

+ InitialScanComplete bool

+ type HostdbHostGET struct

+ Entry ExtendedHostDBEntry

+ ScoreBreakdown modules.HostScoreBreakdown

type HostdbHostsGET

+ Hosts []ExtendedHostDBEntry

+ type SyncerPeer struct

+ Address string

+ Inbound bool

+ Version string

+ type TxpoolBroadcastRequest struct

+ Transactions []types.Transaction

+ V2Transactions []types.V2Transaction

+ type TxpoolTransactionsResponse struct

+ Transactions []types.Transaction

+ V2Transactions []types.V2Transaction

+ type WalletBalanceResponse struct

+ Height uint64

+ ImmatureSiacoins types.Currency

+ IncomingSiacoins types.Currency

+ OutgoingSiacoins types.Currency

+ RecommendedFee types.Currency

+ Siacoins types.Currency

+ Siafunds uint64

+ type WalletOutputsResponse struct

+ SiacoinOutputs []types.SiacoinElement

+ SiafundOutputs []types.SiafundElement

+ type WalletSendRequest struct

+ Amount types.Currency

+ Destination types.Address

v0.10.1

Feb 26, 2024

v0.10.0

Dec 26, 2023

v0.9.2

Dec 18, 2023

v0.9.1

Dec 18, 2023

v0.9.0

Dec 14, 2023

v0.8.0

Nov 18, 2023

v0.7.0

Oct 23, 2023

Changes in this version

+ type Announcement struct

+ Expires uint64

+ Text string

v0.6.0

Oct 17, 2023

v0.5.0

Sep 29, 2023

Changes in this version

+ const StatusModuleNotLoaded

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

+ 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 RegisterRoutesConsensus(router *httprouter.Router, cs modules.ConsensusSet)

+ func RegisterRoutesGateway(router *httprouter.Router, g modules.Gateway, requiredPassword string)

+ func RegisterRoutesTransactionPool(router *httprouter.Router, tpool modules.TransactionPool)

+ func RegisterRoutesWallet(router *httprouter.Router, wallet modules.Wallet, requiredPassword string)

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

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

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

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

+ func WriteSuccess(w http.ResponseWriter)

+ type API struct

+ Shutdown func() error

+ func New(requiredUserAgent string, requiredPassword string, g modules.Gateway, ...) *API

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

+ func (api *API) SetModules(g modules.Gateway, cs modules.ConsensusSet, m modules.Manager, ...)

+ func (api *API) UnrecognizedCallHandler(w http.ResponseWriter, _ *http.Request)

+ type ConsensusBlocksGet struct

+ Difficulty types.Currency

+ Height uint64

+ ID types.BlockID

+ MinerPayouts []types.SiacoinOutput

+ Nonce uint64

+ ParentID types.BlockID

+ Timestamp time.Time

+ Transactions []ConsensusBlocksGetTxn

+ type ConsensusBlocksGetFileContract struct

+ FileMerkleRoot types.Hash256

+ Filesize uint64

+ ID types.FileContractID

+ MissedProofOutputs []ConsensusBlocksGetSiacoinOutput

+ Payout types.Currency

+ RevisionNumber uint64

+ UnlockHash types.Hash256

+ ValidProofOutputs []ConsensusBlocksGetSiacoinOutput

+ WindowEnd uint64

+ WindowStart uint64

+ type ConsensusBlocksGetSiacoinOutput struct

+ Address types.Address

+ ID types.SiacoinOutputID

+ Value types.Currency

+ type ConsensusBlocksGetSiafundOutput struct

+ Address types.Address

+ ID types.SiafundOutputID

+ Value uint64

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

+ CurrentBlock types.BlockID

+ Difficulty types.Currency

+ Height uint64

+ Synced bool

+ Target modules.Target

+ type ConsensusHeadersGET struct

+ BlockID types.BlockID

+ type DaemonAlertsGet struct

+ Alerts []modules.Alert

+ CriticalAlerts []modules.Alert

+ ErrorAlerts []modules.Alert

+ InfoAlerts []modules.Alert

+ WarningAlerts []modules.Alert

+ type DaemonVersion struct

+ BuildTime string

+ GitRevision string

+ Version string

+ type DaemonVersionGet struct

+ BuildTime string

+ GitRevision string

+ Version string

+ type EmailPreferences struct

+ Email string

+ WarnThreshold types.Currency

+ type Error struct

+ Message string

+ func (err Error) Error() string

+ type ExchangeRate struct

+ Currency string

+ Rate float64

+ type ExtendedHostDBEntry struct

+ PublicKeyString string

+ type GatewayBlocklistGET struct

+ Blocklist []string

+ type GatewayBlocklistPOST struct

+ Action string

+ Addresses []string

+ type GatewayGET struct

+ NetAddress modules.NetAddress

+ Online bool

+ Peers []modules.Peer

+ type HostAverages struct

+ Rate float64

+ type HostdbActiveGET struct

+ Hosts []ExtendedHostDBEntry

+ type HostdbAllGET struct

+ Hosts []ExtendedHostDBEntry

+ type HostdbFilterModeGET struct

+ FilterMode string

+ Hosts []string

+ NetAddresses []string

+ type HostdbFilterModePOST struct

+ FilterMode string

+ Hosts []types.PublicKey

+ NetAddresses []string

+ type HostdbGet struct

+ BlockHeight uint64

+ InitialScanComplete bool

+ type HostdbHostsGET struct

+ Entry ExtendedHostDBEntry

+ ScoreBreakdown modules.HostScoreBreakdown

+ type Renter struct

+ Email string

+ PublicKey types.PublicKey

+ type RenterContract struct

+ BadContract bool

+ DownloadSpending types.Currency

+ EndHeight uint64

+ Fees types.Currency

+ FundAccountSpending types.Currency

+ GoodForRenew bool

+ GoodForUpload bool

+ HostPublicKey types.PublicKey

+ HostVersion string

+ ID types.FileContractID

+ LastTransaction types.Transaction

+ MaintenanceSpending modules.MaintenanceSpending

+ NetAddress string

+ RenterFunds types.Currency

+ RenterPublicKey types.PublicKey

+ Size uint64

+ StartHeight uint64

+ StorageSpending types.Currency

+ TotalCost types.Currency

+ UploadSpending types.Currency

+ type RenterContracts struct

+ ActiveContracts []RenterContract

+ DisabledContracts []RenterContract

+ ExpiredContracts []RenterContract

+ ExpiredRefreshedContracts []RenterContract

+ PassiveContracts []RenterContract

+ RefreshedContracts []RenterContract

+ type RentersGET struct

+ Renters []Renter

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

+ Transactions []types.Transaction

+ type WalletAddressGET struct

+ Address types.Address

+ type WalletAddressesGET struct

+ Addresses []types.Address

+ type WalletGET struct

+ ConfirmedSiacoinBalance types.Currency

+ DustThreshold types.Currency

+ Encrypted bool

+ Height uint64

+ Rescanning bool

+ 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

+ Transactions []types.Transaction

+ type WalletSignPOSTParams struct

+ ToSign []types.Hash256

+ Transaction types.Transaction

+ type WalletSignPOSTResp struct

+ Transaction types.Transaction

+ type WalletSweepPOST struct

+ Coins 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 WalletVerifyPasswordGET struct

+ Valid bool

+ type WalletWatchGET struct

+ Addresses []types.Address

+ type WalletWatchPOST struct

+ Addresses []types.Address

+ Remove bool

+ Unused bool

v0.4.0-beta

Sep 10, 2023

v0.3.2-beta

Aug 5, 2023

v0.3.1-beta

Aug 3, 2023

v0.3.0-beta

Jul 31, 2023

v0.2.0-beta

May 18, 2023

v0.1.0-beta

Apr 23, 2023

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