10 "github.com/kr/secureheader"
11 log "github.com/sirupsen/logrus"
12 cmn "github.com/tendermint/tmlibs/common"
14 "github.com/bytom/vapor/accesstoken"
15 cfg "github.com/bytom/vapor/config"
16 "github.com/bytom/vapor/dashboard/dashboard"
17 "github.com/bytom/vapor/dashboard/equity"
18 "github.com/bytom/vapor/errors"
19 "github.com/bytom/vapor/event"
20 "github.com/bytom/vapor/net/http/authn"
21 "github.com/bytom/vapor/net/http/gzip"
22 "github.com/bytom/vapor/net/http/httpjson"
23 "github.com/bytom/vapor/net/http/static"
24 "github.com/bytom/vapor/net/websocket"
25 "github.com/bytom/vapor/netsync/peers"
26 "github.com/bytom/vapor/p2p"
27 "github.com/bytom/vapor/proposal/blockproposer"
28 "github.com/bytom/vapor/protocol"
29 "github.com/bytom/vapor/wallet"
33 errNotAuthenticated = errors.New("not authenticated")
34 httpReadTimeout = 2 * time.Minute
35 httpWriteTimeout = time.Hour
39 // SUCCESS indicates the rpc calling is successful.
41 // FAIL indicated the rpc calling is failed.
46 // Response describes the response standard.
47 type Response struct {
48 Status string `json:"status,omitempty"`
49 Code string `json:"code,omitempty"`
50 Msg string `json:"msg,omitempty"`
51 ErrorDetail string `json:"error_detail,omitempty"`
52 Data interface{} `json:"data,omitempty"`
55 //NewSuccessResponse success response
56 func NewSuccessResponse(data interface{}) Response {
57 return Response{Status: SUCCESS, Data: data}
60 //FormatErrResp format error response
61 func FormatErrResp(err error) (response Response) {
62 response = Response{Status: FAIL}
63 root := errors.Root(err)
64 // Some types cannot be used as map keys, for example slices.
65 // If an error's underlying type is one of these, don't panic.
66 // Just treat it like any other missing entry.
68 if err := recover(); err != nil {
69 response.ErrorDetail = ""
73 if info, ok := respErrFormatter[root]; ok {
74 response.Code = info.ChainCode
75 response.Msg = info.Message
76 response.ErrorDetail = err.Error()
78 response.Code = respErrFormatter[ErrDefault].ChainCode
79 response.Msg = respErrFormatter[ErrDefault].Message
80 response.ErrorDetail = err.Error()
85 //NewErrorResponse error response
86 func NewErrorResponse(err error) Response {
87 response := FormatErrResp(err)
91 type waitHandler struct {
96 func (wh *waitHandler) Set(h http.Handler) {
101 func (wh *waitHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
103 wh.h.ServeHTTP(w, req)
106 // API is the scheduling center for server
109 wallet *wallet.Wallet
110 accessTokens *accesstoken.CredentialStore
111 chain *protocol.Chain
114 blockProposer *blockproposer.BlockProposer
115 notificationMgr *websocket.WSNotificationManager
116 eventDispatcher *event.Dispatcher
119 func (a *API) initServer(config *cfg.Config) {
120 // The waitHandler accepts incoming requests, but blocks until its underlying
121 // handler is set, when the second phase is complete.
122 var coreHandler waitHandler
123 var handler http.Handler
125 coreHandler.wg.Add(1)
126 mux := http.NewServeMux()
127 mux.Handle("/", &coreHandler)
129 handler = AuthHandler(mux, a.accessTokens, config.Auth.Disable)
130 handler = RedirectHandler(handler)
132 secureheader.DefaultConfig.PermitClearLoopback = true
133 secureheader.DefaultConfig.HTTPSRedirect = false
134 secureheader.DefaultConfig.Next = handler
136 a.server = &http.Server{
137 // Note: we should not set TLSConfig here;
138 // we took care of TLS with the listener in maybeUseTLS.
139 Handler: secureheader.DefaultConfig,
140 ReadTimeout: httpReadTimeout,
141 WriteTimeout: httpWriteTimeout,
142 // Disable HTTP/2 for now until the Go implementation is more stable.
143 // https://github.com/golang/go/issues/16450
144 // https://github.com/golang/go/issues/17071
145 TLSNextProto: map[string]func(*http.Server, *tls.Conn, http.Handler){},
151 // StartServer start the server
152 func (a *API) StartServer(address string) {
153 log.WithFields(log.Fields{"module": logModule, "api address:": address}).Info("Rpc listen")
154 listener, err := net.Listen("tcp", address)
156 cmn.Exit(cmn.Fmt("Failed to register tcp port: %v", err))
159 // The `Serve` call has to happen in its own goroutine because
160 // it's blocking and we need to proceed to the rest of the core setup after
163 if err := a.server.Serve(listener); err != nil {
164 log.WithFields(log.Fields{"module": logModule, "error": errors.Wrap(err, "Serve")}).Error("Rpc server")
169 type NetSync interface {
174 BestPeer() *peers.PeerInfo
175 DialPeerWithAddress(addr *p2p.NetAddress) error
176 GetPeerInfos() []*peers.PeerInfo
177 StopPeer(peerID string) error
180 // NewAPI create and initialize the API
181 func NewAPI(sync NetSync, wallet *wallet.Wallet, blockProposer *blockproposer.BlockProposer, chain *protocol.Chain, config *cfg.Config, token *accesstoken.CredentialStore, dispatcher *event.Dispatcher, notificationMgr *websocket.WSNotificationManager) *API {
187 blockProposer: blockProposer,
188 eventDispatcher: dispatcher,
189 notificationMgr: notificationMgr,
192 api.initServer(config)
197 func (a *API) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
198 a.handler.ServeHTTP(rw, req)
201 // buildHandler is in charge of all the rpc handling.
202 func (a *API) buildHandler() {
203 walletEnable := false
204 m := http.NewServeMux()
207 m.Handle("/create-account", jsonHandler(a.createAccount))
208 m.Handle("/update-account-alias", jsonHandler(a.updateAccountAlias))
209 m.Handle("/list-accounts", jsonHandler(a.listAccounts))
210 m.Handle("/delete-account", jsonHandler(a.deleteAccount))
212 m.Handle("/create-account-receiver", jsonHandler(a.createAccountReceiver))
213 m.Handle("/list-addresses", jsonHandler(a.listAddresses))
214 m.Handle("/validate-address", jsonHandler(a.validateAddress))
215 m.Handle("/list-pubkeys", jsonHandler(a.listPubKeys))
217 m.Handle("/get-mining-address", jsonHandler(a.getMiningAddress))
218 m.Handle("/set-mining-address", jsonHandler(a.setMiningAddress))
220 m.Handle("/get-coinbase-arbitrary", jsonHandler(a.getCoinbaseArbitrary))
221 m.Handle("/set-coinbase-arbitrary", jsonHandler(a.setCoinbaseArbitrary))
223 m.Handle("/update-asset-alias", jsonHandler(a.updateAssetAlias))
224 m.Handle("/get-asset", jsonHandler(a.getAsset))
225 m.Handle("/list-assets", jsonHandler(a.listAssets))
227 m.Handle("/create-key", jsonHandler(a.pseudohsmCreateKey))
228 m.Handle("/update-key-alias", jsonHandler(a.pseudohsmUpdateKeyAlias))
229 m.Handle("/list-keys", jsonHandler(a.pseudohsmListKeys))
230 m.Handle("/delete-key", jsonHandler(a.pseudohsmDeleteKey))
231 m.Handle("/reset-key-password", jsonHandler(a.pseudohsmResetPassword))
232 m.Handle("/check-key-password", jsonHandler(a.pseudohsmCheckPassword))
233 m.Handle("/sign-message", jsonHandler(a.signMessage))
235 m.Handle("/build-transaction", jsonHandler(a.build))
236 m.Handle("/build-chain-transactions", jsonHandler(a.buildChainTxs))
237 m.Handle("/sign-transaction", jsonHandler(a.signTemplate))
238 m.Handle("/sign-transactions", jsonHandler(a.signTemplates))
240 m.Handle("/get-transaction", jsonHandler(a.getTransaction))
241 m.Handle("/list-transactions", jsonHandler(a.listTransactions))
243 m.Handle("/list-balances", jsonHandler(a.listBalances))
244 m.Handle("/list-unspent-outputs", jsonHandler(a.listUnspentOutputs))
245 m.Handle("/list-account-votes", jsonHandler(a.listAccountVotes))
247 m.Handle("/decode-program", jsonHandler(a.decodeProgram))
249 m.Handle("/backup-wallet", jsonHandler(a.backupWalletImage))
250 m.Handle("/restore-wallet", jsonHandler(a.restoreWalletImage))
251 m.Handle("/rescan-wallet", jsonHandler(a.rescanWallet))
252 m.Handle("/wallet-info", jsonHandler(a.getWalletInfo))
253 m.Handle("/recovery-wallet", jsonHandler(a.recoveryFromRootXPubs))
255 log.Warn("Please enable wallet")
258 m.Handle("/", alwaysError(errors.New("not Found")))
259 m.Handle("/error", jsonHandler(a.walletError))
261 m.Handle("/create-access-token", jsonHandler(a.createAccessToken))
262 m.Handle("/list-access-tokens", jsonHandler(a.listAccessTokens))
263 m.Handle("/delete-access-token", jsonHandler(a.deleteAccessToken))
264 m.Handle("/check-access-token", jsonHandler(a.checkAccessToken))
266 m.Handle("/submit-transaction", jsonHandler(a.submit))
267 m.Handle("/submit-transactions", jsonHandler(a.submitTxs))
268 m.Handle("/estimate-transaction-gas", jsonHandler(a.estimateTxGas))
270 m.Handle("/get-unconfirmed-transaction", jsonHandler(a.getUnconfirmedTx))
271 m.Handle("/list-unconfirmed-transactions", jsonHandler(a.listUnconfirmedTxs))
272 m.Handle("/decode-raw-transaction", jsonHandler(a.decodeRawTransaction))
274 m.Handle("/get-block", jsonHandler(a.getBlock))
275 m.Handle("/get-raw-block", jsonHandler(a.getRawBlock))
276 m.Handle("/get-block-hash", jsonHandler(a.getBestBlockHash))
277 m.Handle("/get-block-header", jsonHandler(a.getBlockHeader))
278 m.Handle("/get-block-count", jsonHandler(a.getBlockCount))
280 m.Handle("/is-mining", jsonHandler(a.isMining))
281 m.Handle("/set-mining", jsonHandler(a.setMining))
283 m.Handle("/verify-message", jsonHandler(a.verifyMessage))
284 m.Handle("/compile", jsonHandler(a.compileEquity))
286 m.Handle("/gas-rate", jsonHandler(a.gasRate))
287 m.Handle("/net-info", jsonHandler(a.getNetInfo))
289 m.Handle("/list-peers", jsonHandler(a.listPeers))
290 m.Handle("/disconnect-peer", jsonHandler(a.disconnectPeer))
291 m.Handle("/connect-peer", jsonHandler(a.connectPeer))
293 m.Handle("/get-merkle-proof", jsonHandler(a.getMerkleProof))
295 m.Handle("/get-vote-result", jsonHandler(a.getVoteResult))
297 m.HandleFunc("/websocket-subscribe", a.websocketHandler)
299 handler := walletHandler(m, walletEnable)
300 handler = webAssetsHandler(handler)
301 handler = gzip.Handler{Handler: handler}
306 func jsonHandler(f interface{}) http.Handler {
307 h, err := httpjson.Handler(f, errorFormatter.Write)
315 func alwaysError(err error) http.Handler {
316 return jsonHandler(func() error { return err })
319 func webAssetsHandler(next http.Handler) http.Handler {
320 mux := http.NewServeMux()
321 mux.Handle("/dashboard/", http.StripPrefix("/dashboard/", static.Handler{
322 Assets: dashboard.Files,
323 Default: "index.html",
325 mux.Handle("/equity/", http.StripPrefix("/equity/", static.Handler{
326 Assets: equity.Files,
327 Default: "index.html",
329 mux.Handle("/", next)
334 // AuthHandler access token auth Handler
335 func AuthHandler(handler http.Handler, accessTokens *accesstoken.CredentialStore, authDisable bool) http.Handler {
336 authenticator := authn.NewAPI(accessTokens, authDisable)
338 return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
339 // TODO(tessr): check that this path exists; return early if this path isn't legit
340 req, err := authenticator.Authenticate(req)
342 log.WithFields(log.Fields{"module": logModule, "error": errors.Wrap(err, "Serve")}).Error("Authenticate fail")
343 err = errors.WithDetail(errNotAuthenticated, err.Error())
344 errorFormatter.Write(req.Context(), rw, err)
347 handler.ServeHTTP(rw, req)
351 // RedirectHandler redirect to dashboard handler
352 func RedirectHandler(next http.Handler) http.Handler {
353 return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
354 if req.URL.Path == "/" {
355 http.Redirect(w, req, "/dashboard/", http.StatusFound)
358 next.ServeHTTP(w, req)
362 func walletHandler(m *http.ServeMux, walletEnable bool) http.Handler {
363 return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
364 // when the wallet is not been opened and the url path is not been found, modify url path to error,
365 // and redirect handler to error
366 if _, pattern := m.Handler(req); pattern != req.URL.Path && !walletEnable {
367 req.URL.Path = "/error"
368 walletRedirectHandler(w, req)
376 // walletRedirectHandler redirect to error when the wallet is closed
377 func walletRedirectHandler(w http.ResponseWriter, req *http.Request) {
378 h := http.RedirectHandler(req.URL.String(), http.StatusMovedPermanently)