Documentation
¶
Index ¶
- func AtMostOne(query url.Values, names ...string) bool
- func EncodeSequence(val uint64) []byte
- func ExtractAddress(rawAddr string) ([]byte, error)
- func ExtractNumericID(s string) ([]byte, error)
- func ExtractOffsetFromParam(param string) ([]byte, error)
- func ExtractRefID(s string) ([]byte, error)
- func ExtractStrID(s string) ([]byte, error)
- func JSONErr(w http.ResponseWriter, code int, errText string)
- func JSONErrs(w http.ResponseWriter, code int, errs []string)
- func JSONRedirect(w http.ResponseWriter, code int, urlStr string)
- func JSONResp(w http.ResponseWriter, code int, content interface{})
- func LastChunk(path string) string
- func NextKeyValue(b []byte) []byte
- func RefKey(raw []byte) (string, error)
- func SequenceKey(raw []byte) (string, error)
- func WeaveAddressFromQuery(rawAddr string) (weave.Address, error)
- type BlocksHandler
- type CashBalanceHandler
- type DefaultHandler
- type EscrowEscrowsHandler
- type GconfHandler
- type GovProposalsHandler
- type GovVotesHandler
- type InfoHandler
- type MsgFeeHandler
- type MultipleObjectsResponse
- type MultisigContractsHandler
- type NonceAddressHandler
- type NoncePubKeyHandler
- type OwnerHandler
- type ResolveHandler
- type TxSubmitHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AtMostOne ¶ added in v0.21.4
AtMostOne returns true if at most one non empty value from given list of names exists in the query.
func EncodeSequence ¶ added in v0.21.4
func ExtractAddress ¶ added in v0.21.4
func ExtractNumericID ¶ added in v0.21.4
func ExtractOffsetFromParam ¶ added in v0.21.4
Offset is sent as int and converted to binary
func ExtractRefID ¶ added in v0.21.4
func ExtractStrID ¶ added in v0.21.4
func JSONErr ¶
func JSONErr(w http.ResponseWriter, code int, errText string)
JSONErr write single error as JSON encoded response.
func JSONErrs ¶
func JSONErrs(w http.ResponseWriter, code int, errs []string)
JSONErrs write multiple errors as JSON encoded response.
func JSONRedirect ¶
func JSONRedirect(w http.ResponseWriter, code int, urlStr string)
JSONRedirect return redirect response, but with JSON formatted body.
func JSONResp ¶
func JSONResp(w http.ResponseWriter, code int, content interface{})
JSONResp write content as JSON encoded response.
func LastChunk ¶ added in v0.21.4
LastChunk returns last path chunk - everything after the last `/` character. For example LAST in /foo/bar/LAST and empty string in /foo/bar/
func NextKeyValue ¶ added in v0.21.4
func SequenceKey ¶ added in v0.21.4
Types ¶
type BlocksHandler ¶
func (*BlocksHandler) ServeHTTP ¶
func (h *BlocksHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
BlocksHandler godoc @Summary Get block details by height @Description get block detail by blockHeight @Tags Status @Param blockHeight path int true "Block Height" @Success 200 @Failure 404 @Redirect 303 @Router /blocks/{blockHeight} [get]
type CashBalanceHandler ¶
func (*CashBalanceHandler) ServeHTTP ¶
func (h *CashBalanceHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
CashBalanceHandler godoc @Summary returns balance in IOV Token of the given iov address @Description The iov address may be in the bech32 (iov....) or hex (ON3LK...) format. @Tags IOV token @Param address query string false "Bech32 or hex representation of an address" @Param offset query int false "Pagination offset" @Success 200 @Failure 404 @Failure 500 @Router /cash/balances [get]
type DefaultHandler ¶
type DefaultHandler struct{}
DefaultHandler is used to handle the request that no other handler wants.
func (*DefaultHandler) ServeHTTP ¶
func (h *DefaultHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
type EscrowEscrowsHandler ¶
func (*EscrowEscrowsHandler) ServeHTTP ¶
func (h *EscrowEscrowsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
EscrowEscrowsHandler godoc @Summary Returns a list of all the smart contract Escrows. @Description At most one of the query parameters must exist(excluding offset) @Tags IOV token @Param prefix query string false "Query prefix encoded as hex" @Param source query string false "Source address" @Param destination query string false "Destination address" @Success 200 {object} handlers.MultipleObjectsResponse @Failure 404 @Failure 400 @Failure 500 @Router /escrow/escrows [get]
type GconfHandler ¶
type GconfHandler struct {
Bns client.BnsClient
Confs map[string]func() gconf.Configuration
}
func (*GconfHandler) ServeHTTP ¶
func (h *GconfHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
GconfHandler godoc @Summary Get configuration with extension name @Tags Status @Param extensionName path string true "Extension name" @Success 200 {object} gconf.Configuration @Failure 404 @Failure 500 @Router /gconf/{extensionName} [get]
type GovProposalsHandler ¶
func (*GovProposalsHandler) ServeHTTP ¶
func (h *GovProposalsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
GovProposalsHandler godoc @Summary Returns a list of x/gov Votes entities. @Description At most one of the query parameters must exist(excluding offset) @Tags Governance @Param author query string false "Author address" @Param electorate query string false "Base64 encoded electorate ID" @Param elector query string false "Base64 encoded Elector ID" @Param electorate_id query int false "Integer Electorate ID" @Param offset query int false "Pagination offset" @Success 200 {object} handlers.MultipleObjectsResponse @Failure 404 @Failure 400 @Failure 500 @Router /gov/proposals [get]
type GovVotesHandler ¶
func (*GovVotesHandler) ServeHTTP ¶
func (h *GovVotesHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
GovVotesHandler godoc @Summary Returns a list of Votes made on the governance. @Description At most one of the query parameters must exist(excluding offset) @Tags Governance @Param proposal query string false "Base64 encoded Proposal ID" @Param proposal_id query int false "Integer encoded Proposal ID" @Param elector query string false "Base64 encoded Elector ID" @Param elector_id query int false "Integer encoded Elector ID" @Param offset query int false "Pagination offset" @Success 200 {object} handlers.MultipleObjectsResponse @Failure 404 @Failure 400 @Failure 500 @Router /gov/votes [get]
type InfoHandler ¶
type InfoHandler struct{}
func (*InfoHandler) ServeHTTP ¶
func (h *InfoHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
InfoHandler godoc @Summary Returns information about this instance of `bnsapi`. @Tags Status @Success 200 @Router /info/ [get]
type MsgFeeHandler ¶ added in v0.21.4
func (*MsgFeeHandler) ServeHTTP ¶ added in v0.21.4
func (h *MsgFeeHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
MsgFeeHandler godoc @Summary Return message fee information based on message path: username/register_token @Description If msgfee parameter is provided return the queried mesgfee information @Description otherwise returns all available msgfees @Param msgfee query string false "ex: username/register_token" @Tags Message Fee @Success 200 {object} msgfee.MsgFee @Failure 404 @Failure 500 @Router /msgfee/msgfees [get]
type MultipleObjectsResponse ¶ added in v0.21.4
type MultisigContractsHandler ¶
func (*MultisigContractsHandler) ServeHTTP ¶
func (h *MultisigContractsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
MultisigContractsHandler godoc @Summary Returns a list of all the multisig Contracts. @Description At most one of the query parameters must exist(excluding offset) @Tags IOV token @Param prefix query string false "Return objects with keys that start with given prefix" @Success 200 {object} handlers.MultipleObjectsResponse @Failure 404 @Failure 500 @Router /multisig/contracts [get]
type NonceAddressHandler ¶ added in v0.21.4
func (*NonceAddressHandler) ServeHTTP ¶ added in v0.21.4
func (h *NonceAddressHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
NonceAddressHandler godoc @Summary Returns nonce based on an address @Description Returns nonce and public key registered for a given address if it was ever used. @Param address path string true "Address to query for nonce. ex: iov1qnpaklxv4n6cam7v99hl0tg0dkmu97sh6007un" @Tags Nonce @Success 200 @Failure 404 @Failure 500 @Router /account/nonce/address/{address} [get]
type NoncePubKeyHandler ¶ added in v0.21.4
func (*NoncePubKeyHandler) ServeHTTP ¶ added in v0.21.4
func (h *NoncePubKeyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
NonceAddressHandler godoc @Summary Returns nonce based on an address @Description Returns nonce and public key registered for a given pubkey if it was ever used. @Param pubKey path string true "Public key to query for nonce. ex: 12ee6f581fe55673a1e9e1382a0829e32075a0aa4763c968bc526e1852e78c95" @Tags Nonce @Success 200 @Failure 404 @Failure 500 @Router /account/nonce/pubkey/{pubKey} [get]
type OwnerHandler ¶ added in v0.21.4
func (*OwnerHandler) ServeHTTP ¶ added in v0.21.4
func (h *OwnerHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
OwnerHandler godoc @Summary Returns the username object with associated info for an owner @Tags Starname @Param address path string false "Address. example: 04C3DB7CCCACF58EEFCC296FF7AD0F6DB7C2FA17 or iov1qnpaklxv4n6cam7v99hl0tg0dkmu97sh6007un" @Success 200 {object} username.Token @Failure 404 @Failure 500 @Router /username/owner/{address} [get]
type ResolveHandler ¶ added in v0.21.4
func (*ResolveHandler) ServeHTTP ¶ added in v0.21.4
func (h *ResolveHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
ResolveHandler godoc @Summary Returns the username object with associated info for an iov username, like thematrix*iov @Tags Starname @Param username path string false "username. example: thematrix*iov" @Success 200 {object} username.Token @Failure 404 @Failure 500 @Router /username/resolve/{username} [get]
type TxSubmitHandler ¶ added in v0.21.4
func (*TxSubmitHandler) ServeHTTP ¶ added in v0.21.4
func (h *TxSubmitHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
TxSubmitHandler @Summary Submit transaction @Description Submit transaction to the blockchain @Tags Transaction @Accept plain @Param tx body string true "base64 encoded transaction" @Success 200 @Failure 404 @Redirect 303 @Router /tx/submit [post]
Source Files