10 "github.com/kr/secureheader"
11 log "github.com/sirupsen/logrus"
12 cmn "github.com/tendermint/tmlibs/common"
14 "github.com/vapor/accesstoken"
15 "github.com/vapor/blockchain/txfeed"
16 cfg "github.com/vapor/config"
17 "github.com/vapor/dashboard/dashboard"
18 "github.com/vapor/dashboard/equity"
19 "github.com/vapor/errors"
20 "github.com/vapor/mining/cpuminer"
21 "github.com/vapor/mining/miningpool"
22 "github.com/vapor/net/http/authn"
23 "github.com/vapor/net/http/gzip"
24 "github.com/vapor/net/http/httpjson"
25 "github.com/vapor/net/http/static"
26 "github.com/vapor/net/websocket"
27 "github.com/vapor/netsync"
28 "github.com/vapor/protocol"
29 "github.com/vapor/protocol/bc"
30 "github.com/vapor/wallet"
34 errNotAuthenticated = errors.New("not authenticated")
35 httpReadTimeout = 2 * time.Minute
36 httpWriteTimeout = time.Hour
40 // SUCCESS indicates the rpc calling is successful.
42 // 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
108 sync *netsync.SyncManager
109 wallet *wallet.Wallet
110 accessTokens *accesstoken.CredentialStore
111 chain *protocol.Chain
114 txFeedTracker *txfeed.Tracker
115 cpuMiner *cpuminer.CPUMiner
116 miningPool *miningpool.MiningPool
117 notificationMgr *websocket.WSNotificationManager
118 newBlockCh chan *bc.Hash
121 func (a *API) initServer(config *cfg.Config) {
122 // The waitHandler accepts incoming requests, but blocks until its underlying
123 // handler is set, when the second phase is complete.
124 var coreHandler waitHandler
125 var handler http.Handler
127 coreHandler.wg.Add(1)
128 mux := http.NewServeMux()
129 mux.Handle("/", &coreHandler)
131 handler = AuthHandler(mux, a.accessTokens, config.Auth.Disable)
132 handler = RedirectHandler(handler)
134 secureheader.DefaultConfig.PermitClearLoopback = true
135 secureheader.DefaultConfig.HTTPSRedirect = false
136 secureheader.DefaultConfig.Next = handler
138 a.server = &http.Server{
139 // Note: we should not set TLSConfig here;
140 // we took care of TLS with the listener in maybeUseTLS.
141 Handler: secureheader.DefaultConfig,
142 ReadTimeout: httpReadTimeout,
143 WriteTimeout: httpWriteTimeout,
144 // Disable HTTP/2 for now until the Go implementation is more stable.
145 // https://github.com/golang/go/issues/16450
146 // https://github.com/golang/go/issues/17071
147 TLSNextProto: map[string]func(*http.Server, *tls.Conn, http.Handler){},
153 // StartServer start the server
154 func (a *API) StartServer(address string) {
155 log.WithField("api address:", address).Info("Rpc listen")
156 listener, err := net.Listen("tcp", address)
158 cmn.Exit(cmn.Fmt("Failed to register tcp port: %v", err))
161 // The `Serve` call has to happen in its own goroutine because
162 // it's blocking and we need to proceed to the rest of the core setup after
165 if err := a.server.Serve(listener); err != nil {
166 log.WithField("error", errors.Wrap(err, "Serve")).Error("Rpc server")
171 // NewAPI create and initialize the API
172 func NewAPI(sync *netsync.SyncManager, wallet *wallet.Wallet, txfeeds *txfeed.Tracker, cpuMiner *cpuminer.CPUMiner, miningPool *miningpool.MiningPool, chain *protocol.Chain, config *cfg.Config, token *accesstoken.CredentialStore, newBlockCh chan *bc.Hash, notificationMgr *websocket.WSNotificationManager) *API {
178 txFeedTracker: txfeeds,
180 miningPool: miningPool,
182 newBlockCh: newBlockCh,
183 notificationMgr: notificationMgr,
186 api.initServer(config)
191 func (a *API) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
192 a.handler.ServeHTTP(rw, req)
195 // buildHandler is in charge of all the rpc handling.
196 func (a *API) buildHandler() {
197 walletEnable := false
198 m := http.NewServeMux()
202 m.Handle("/create-account", jsonHandler(a.createAccount))
203 m.Handle("/update-account-alias", jsonHandler(a.updateAccountAlias))
204 m.Handle("/list-accounts", jsonHandler(a.listAccounts))
205 m.Handle("/delete-account", jsonHandler(a.deleteAccount))
207 m.Handle("/create-account-receiver", jsonHandler(a.createAccountReceiver))
208 m.Handle("/list-addresses", jsonHandler(a.listAddresses))
209 m.Handle("/validate-address", jsonHandler(a.validateAddress))
210 m.Handle("/list-pubkeys", jsonHandler(a.listPubKeys))
212 m.Handle("/get-mining-address", jsonHandler(a.getMiningAddress))
213 m.Handle("/set-mining-address", jsonHandler(a.setMiningAddress))
215 m.Handle("/get-coinbase-arbitrary", jsonHandler(a.getCoinbaseArbitrary))
216 m.Handle("/set-coinbase-arbitrary", jsonHandler(a.setCoinbaseArbitrary))
218 m.Handle("/create-asset", jsonHandler(a.createAsset))
219 m.Handle("/update-asset-alias", jsonHandler(a.updateAssetAlias))
220 m.Handle("/get-asset", jsonHandler(a.getAsset))
221 m.Handle("/list-assets", jsonHandler(a.listAssets))
223 m.Handle("/create-key", jsonHandler(a.pseudohsmCreateKey))
224 m.Handle("/update-key-alias", jsonHandler(a.pseudohsmUpdateKeyAlias))
225 m.Handle("/list-keys", jsonHandler(a.pseudohsmListKeys))
226 m.Handle("/delete-key", jsonHandler(a.pseudohsmDeleteKey))
227 m.Handle("/reset-key-password", jsonHandler(a.pseudohsmResetPassword))
228 m.Handle("/check-key-password", jsonHandler(a.pseudohsmCheckPassword))
229 m.Handle("/sign-message", jsonHandler(a.signMessage))
231 m.Handle("/build-transaction", jsonHandler(a.build))
232 m.Handle("/build-chain-transactions", jsonHandler(a.buildChainTxs))
233 m.Handle("/sign-transaction", jsonHandler(a.signTemplate))
234 m.Handle("/sign-transactions", jsonHandler(a.signTemplates))
236 m.Handle("/get-transaction", jsonHandler(a.getTransaction))
237 m.Handle("/list-transactions", jsonHandler(a.listTransactions))
239 m.Handle("/list-balances", jsonHandler(a.listBalances))
240 m.Handle("/list-unspent-outputs", jsonHandler(a.listUnspentOutputs))
242 m.Handle("/decode-program", jsonHandler(a.decodeProgram))
244 m.Handle("/backup-wallet", jsonHandler(a.backupWalletImage))
245 m.Handle("/restore-wallet", jsonHandler(a.restoreWalletImage))
246 m.Handle("/rescan-wallet", jsonHandler(a.rescanWallet))
247 m.Handle("/wallet-info", jsonHandler(a.getWalletInfo))
248 m.Handle("/recovery-wallet", jsonHandler(a.recoveryFromRootXPubs))
250 m.Handle("/get-pegin-address", jsonHandler(a.getPeginAddress))
251 m.Handle("/get-pegin-contract", jsonHandler(a.getPeginContract))
252 m.Handle("/claim-pegin-transaction", jsonHandler(a.claimPeginTx))
253 m.Handle("/create-key-pair", jsonHandler(a.createXKeys))
254 m.Handle("/get-utxo-from-transaction", jsonHandler(a.getUnspentOutputs))
255 m.Handle("/get-side-raw-transaction", jsonHandler(a.getSideRawTransaction))
256 m.Handle("/build-mainchain-tx", jsonHandler(a.buildMainChainTx))
257 m.Handle("/sign-with-key", jsonHandler(a.signWithKey))
259 log.Warn("Please enable wallet")
262 m.Handle("/", alwaysError(errors.New("not Found")))
263 m.Handle("/error", jsonHandler(a.walletError))
265 m.Handle("/create-access-token", jsonHandler(a.createAccessToken))
266 m.Handle("/list-access-tokens", jsonHandler(a.listAccessTokens))
267 m.Handle("/delete-access-token", jsonHandler(a.deleteAccessToken))
268 m.Handle("/check-access-token", jsonHandler(a.checkAccessToken))
270 m.Handle("/create-transaction-feed", jsonHandler(a.createTxFeed))
271 m.Handle("/get-transaction-feed", jsonHandler(a.getTxFeed))
272 m.Handle("/update-transaction-feed", jsonHandler(a.updateTxFeed))
273 m.Handle("/delete-transaction-feed", jsonHandler(a.deleteTxFeed))
274 m.Handle("/list-transaction-feeds", jsonHandler(a.listTxFeeds))
276 m.Handle("/submit-transaction", jsonHandler(a.submit))
277 m.Handle("/submit-transactions", jsonHandler(a.submitTxs))
278 m.Handle("/estimate-transaction-gas", jsonHandler(a.estimateTxGas))
280 m.Handle("/get-unconfirmed-transaction", jsonHandler(a.getUnconfirmedTx))
281 m.Handle("/list-unconfirmed-transactions", jsonHandler(a.listUnconfirmedTxs))
282 m.Handle("/decode-raw-transaction", jsonHandler(a.decodeRawTransaction))
283 m.Handle("/get-raw-transaction", jsonHandler(a.getRawTransaction))
285 m.Handle("/get-block", jsonHandler(a.getBlock))
286 m.Handle("/get-raw-block", jsonHandler(a.getRawBlock))
287 m.Handle("/get-block-hash", jsonHandler(a.getBestBlockHash))
288 m.Handle("/get-block-header", jsonHandler(a.getBlockHeader))
289 m.Handle("/get-block-count", jsonHandler(a.getBlockCount))
290 m.Handle("/get-difficulty", jsonHandler(a.getDifficulty))
291 m.Handle("/get-hash-rate", jsonHandler(a.getHashRate))
293 m.Handle("/is-mining", jsonHandler(a.isMining))
294 m.Handle("/set-mining", jsonHandler(a.setMining))
296 m.Handle("/get-work", jsonHandler(a.getWork))
297 m.Handle("/get-work-json", jsonHandler(a.getWorkJSON))
298 m.Handle("/submit-block", jsonHandler(a.submitBlock))
299 m.Handle("/submit-work", jsonHandler(a.submitWork))
300 m.Handle("/submit-work-json", jsonHandler(a.submitWorkJSON))
302 m.Handle("/verify-message", jsonHandler(a.verifyMessage))
303 m.Handle("/compile", jsonHandler(a.compileEquity))
305 m.Handle("/gas-rate", jsonHandler(a.gasRate))
306 m.Handle("/net-info", jsonHandler(a.getNetInfo))
308 m.Handle("/list-peers", jsonHandler(a.listPeers))
309 m.Handle("/disconnect-peer", jsonHandler(a.disconnectPeer))
310 m.Handle("/connect-peer", jsonHandler(a.connectPeer))
312 m.Handle("/get-merkle-proof", jsonHandler(a.getMerkleProof))
314 m.HandleFunc("/websocket-subscribe", a.websocketHandler)
316 handler := latencyHandler(m, walletEnable)
317 handler = webAssetsHandler(handler)
318 handler = gzip.Handler{Handler: handler}
324 func jsonHandler(f interface{}) http.Handler {
325 h, err := httpjson.Handler(f, errorFormatter.Write)
333 func alwaysError(err error) http.Handler {
334 return jsonHandler(func() error { return err })
337 func webAssetsHandler(next http.Handler) http.Handler {
338 mux := http.NewServeMux()
339 mux.Handle("/dashboard/", http.StripPrefix("/dashboard/", static.Handler{
340 Assets: dashboard.Files,
341 Default: "index.html",
343 mux.Handle("/equity/", http.StripPrefix("/equity/", static.Handler{
344 Assets: equity.Files,
345 Default: "index.html",
347 mux.Handle("/", next)
352 // AuthHandler access token auth Handler
353 func AuthHandler(handler http.Handler, accessTokens *accesstoken.CredentialStore, authDisable bool) http.Handler {
354 authenticator := authn.NewAPI(accessTokens, authDisable)
356 return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
357 // TODO(tessr): check that this path exists; return early if this path isn't legit
358 req, err := authenticator.Authenticate(req)
360 log.WithField("error", errors.Wrap(err, "Serve")).Error("Authenticate fail")
361 err = errors.WithDetail(errNotAuthenticated, err.Error())
362 errorFormatter.Write(req.Context(), rw, err)
365 handler.ServeHTTP(rw, req)
369 // RedirectHandler redirect to dashboard handler
370 func RedirectHandler(next http.Handler) http.Handler {
371 return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
372 if req.URL.Path == "/" {
373 http.Redirect(w, req, "/dashboard/", http.StatusFound)
376 next.ServeHTTP(w, req)
380 // latencyHandler take latency for the request url path, and redirect url path to wait-disable when wallet is closed
381 func latencyHandler(m *http.ServeMux, walletEnable bool) http.Handler {
382 return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
383 // latency for the request url path
384 if l := latency(m, req); l != nil {
385 defer l.RecordSince(time.Now())
388 // when the wallet is not been opened and the url path is not been found, modify url path to error,
389 // and redirect handler to error
390 if _, pattern := m.Handler(req); pattern != req.URL.Path && !walletEnable {
391 req.URL.Path = "/error"
392 walletRedirectHandler(w, req)
400 // walletRedirectHandler redirect to error when the wallet is closed
401 func walletRedirectHandler(w http.ResponseWriter, req *http.Request) {
402 h := http.RedirectHandler(req.URL.String(), http.StatusMovedPermanently)