10 "github.com/kr/secureheader"
11 log "github.com/sirupsen/logrus"
12 cmn "github.com/tendermint/tmlibs/common"
14 "github.com/bytom/accesstoken"
15 "github.com/bytom/blockchain/txfeed"
16 cfg "github.com/bytom/config"
17 "github.com/bytom/dashboard"
18 "github.com/bytom/equity"
19 "github.com/bytom/errors"
20 "github.com/bytom/mining/cpuminer"
21 "github.com/bytom/mining/miningpool"
22 "github.com/bytom/net/http/authn"
23 "github.com/bytom/net/http/gzip"
24 "github.com/bytom/net/http/httpjson"
25 "github.com/bytom/net/http/static"
26 "github.com/bytom/netsync"
27 "github.com/bytom/protocol"
28 "github.com/bytom/wallet"
32 errNotAuthenticated = errors.New("not authenticated")
33 httpReadTimeout = 2 * time.Minute
34 httpWriteTimeout = time.Hour
38 // SUCCESS indicates the rpc calling is successful.
40 // FAIL indicated the rpc calling is failed.
42 crosscoreRPCPrefix = "/rpc/"
45 // Response describes the response standard.
46 type Response struct {
47 Status string `json:"status,omitempty"`
48 Code string `json:"code,omitempty"`
49 Msg string `json:"msg,omitempty"`
50 ErrorDetail string `json:"error_detail,omitempty"`
51 Data interface{} `json:"data,omitempty"`
54 //NewSuccessResponse success response
55 func NewSuccessResponse(data interface{}) Response {
56 return Response{Status: SUCCESS, Data: data}
59 //FormatErrResp format error response
60 func FormatErrResp(err error) (response Response) {
61 response = Response{Status: FAIL}
62 root := errors.Root(err)
63 // Some types cannot be used as map keys, for example slices.
64 // If an error's underlying type is one of these, don't panic.
65 // Just treat it like any other missing entry.
67 if err := recover(); err != nil {
68 response.ErrorDetail = ""
72 if info, ok := respErrFormatter[root]; ok {
73 response.Code = info.ChainCode
74 response.Msg = info.Message
75 response.ErrorDetail = err.Error()
77 response.Code = respErrFormatter[ErrDefault].ChainCode
78 response.Msg = respErrFormatter[ErrDefault].Message
79 response.ErrorDetail = err.Error()
84 //NewErrorResponse error response
85 func NewErrorResponse(err error) Response {
86 response := FormatErrResp(err)
90 type waitHandler struct {
95 func (wh *waitHandler) Set(h http.Handler) {
100 func (wh *waitHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
102 wh.h.ServeHTTP(w, req)
105 // API is the scheduling center for server
107 sync *netsync.SyncManager
108 wallet *wallet.Wallet
109 accessTokens *accesstoken.CredentialStore
110 chain *protocol.Chain
113 txFeedTracker *txfeed.Tracker
114 cpuMiner *cpuminer.CPUMiner
115 miningPool *miningpool.MiningPool
118 func (a *API) initServer(config *cfg.Config) {
119 // The waitHandler accepts incoming requests, but blocks until its underlying
120 // handler is set, when the second phase is complete.
121 var coreHandler waitHandler
122 var handler http.Handler
124 coreHandler.wg.Add(1)
125 mux := http.NewServeMux()
126 mux.Handle("/", &coreHandler)
129 if config.Auth.Disable == false {
130 handler = AuthHandler(handler, a.accessTokens)
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) *API {
178 txFeedTracker: txfeeds,
180 miningPool: miningPool,
183 api.initServer(config)
188 func (a *API) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
189 a.handler.ServeHTTP(rw, req)
192 // buildHandler is in charge of all the rpc handling.
193 func (a *API) buildHandler() {
194 walletEnable := false
195 m := http.NewServeMux()
199 m.Handle("/create-account", jsonHandler(a.createAccount))
200 m.Handle("/list-accounts", jsonHandler(a.listAccounts))
201 m.Handle("/delete-account", jsonHandler(a.deleteAccount))
203 m.Handle("/create-account-receiver", jsonHandler(a.createAccountReceiver))
204 m.Handle("/list-addresses", jsonHandler(a.listAddresses))
205 m.Handle("/validate-address", jsonHandler(a.validateAddress))
206 m.Handle("/list-pubkeys", jsonHandler(a.listPubKeys))
208 m.Handle("/get-mining-address", jsonHandler(a.getMiningAddress))
209 m.Handle("/set-mining-address", jsonHandler(a.setMiningAddress))
211 m.Handle("/create-asset", jsonHandler(a.createAsset))
212 m.Handle("/update-asset-alias", jsonHandler(a.updateAssetAlias))
213 m.Handle("/get-asset", jsonHandler(a.getAsset))
214 m.Handle("/list-assets", jsonHandler(a.listAssets))
216 m.Handle("/create-key", jsonHandler(a.pseudohsmCreateKey))
217 m.Handle("/list-keys", jsonHandler(a.pseudohsmListKeys))
218 m.Handle("/delete-key", jsonHandler(a.pseudohsmDeleteKey))
219 m.Handle("/reset-key-password", jsonHandler(a.pseudohsmResetPassword))
220 m.Handle("/check-key-password", jsonHandler(a.pseudohsmCheckPassword))
221 m.Handle("/sign-message", jsonHandler(a.signMessage))
223 m.Handle("/build-transaction", jsonHandler(a.build))
224 m.Handle("/sign-transaction", jsonHandler(a.pseudohsmSignTemplates))
226 m.Handle("/get-transaction", jsonHandler(a.getTransaction))
227 m.Handle("/list-transactions", jsonHandler(a.listTransactions))
229 m.Handle("/list-balances", jsonHandler(a.listBalances))
230 m.Handle("/list-unspent-outputs", jsonHandler(a.listUnspentOutputs))
232 m.Handle("/backup-wallet", jsonHandler(a.backupWalletImage))
233 m.Handle("/restore-wallet", jsonHandler(a.restoreWalletImage))
234 m.Handle("/rescan-wallet", jsonHandler(a.rescanWallet))
235 m.Handle("/wallet-info", jsonHandler(a.getWalletInfo))
237 log.Warn("Please enable wallet")
240 m.Handle("/", alwaysError(errors.New("not Found")))
241 m.Handle("/error", jsonHandler(a.walletError))
243 m.Handle("/create-access-token", jsonHandler(a.createAccessToken))
244 m.Handle("/list-access-tokens", jsonHandler(a.listAccessTokens))
245 m.Handle("/delete-access-token", jsonHandler(a.deleteAccessToken))
246 m.Handle("/check-access-token", jsonHandler(a.checkAccessToken))
248 m.Handle("/create-transaction-feed", jsonHandler(a.createTxFeed))
249 m.Handle("/get-transaction-feed", jsonHandler(a.getTxFeed))
250 m.Handle("/update-transaction-feed", jsonHandler(a.updateTxFeed))
251 m.Handle("/delete-transaction-feed", jsonHandler(a.deleteTxFeed))
252 m.Handle("/list-transaction-feeds", jsonHandler(a.listTxFeeds))
254 m.Handle("/submit-transaction", jsonHandler(a.submit))
255 m.Handle("/estimate-transaction-gas", jsonHandler(a.estimateTxGas))
257 m.Handle("/get-unconfirmed-transaction", jsonHandler(a.getUnconfirmedTx))
258 m.Handle("/list-unconfirmed-transactions", jsonHandler(a.listUnconfirmedTxs))
259 m.Handle("/decode-raw-transaction", jsonHandler(a.decodeRawTransaction))
261 m.Handle("/get-block-hash", jsonHandler(a.getBestBlockHash))
262 m.Handle("/get-block-header", jsonHandler(a.getBlockHeader))
263 m.Handle("/get-block", jsonHandler(a.getBlock))
264 m.Handle("/get-block-count", jsonHandler(a.getBlockCount))
265 m.Handle("/get-difficulty", jsonHandler(a.getDifficulty))
266 m.Handle("/get-hash-rate", jsonHandler(a.getHashRate))
268 m.Handle("/is-mining", jsonHandler(a.isMining))
269 m.Handle("/set-mining", jsonHandler(a.setMining))
271 m.Handle("/get-work", jsonHandler(a.getWork))
272 m.Handle("/get-work-json", jsonHandler(a.getWorkJSON))
273 m.Handle("/submit-work", jsonHandler(a.submitWork))
274 m.Handle("/submit-work-json", jsonHandler(a.submitWorkJSON))
276 m.Handle("/get-coinbase-arbitrary", jsonHandler(a.getCoinbaseArbitrary))
277 m.Handle("/set-coinbase-arbitrary", jsonHandler(a.setCoinbaseArbitrary))
279 m.Handle("/verify-message", jsonHandler(a.verifyMessage))
280 m.Handle("/decode-program", jsonHandler(a.decodeProgram))
281 m.Handle("/compile", jsonHandler(a.compileEquity))
283 m.Handle("/gas-rate", jsonHandler(a.gasRate))
284 m.Handle("/net-info", jsonHandler(a.getNetInfo))
286 m.Handle("/list-peers", jsonHandler(a.listPeers))
287 m.Handle("/disconnect-peer", jsonHandler(a.disconnectPeer))
288 m.Handle("/connect-peer", jsonHandler(a.connectPeer))
290 handler := latencyHandler(m, walletEnable)
291 handler = maxBytesHandler(handler) // TODO(tessr): consider moving this to non-core specific mux
292 handler = webAssetsHandler(handler)
293 handler = gzip.Handler{Handler: handler}
298 func maxBytesHandler(h http.Handler) http.Handler {
299 const maxReqSize = 1e7 // 10MB
300 return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
301 // A block can easily be bigger than maxReqSize, but everything
302 // else should be pretty small.
303 if req.URL.Path != crosscoreRPCPrefix+"signer/sign-block" {
304 req.Body = http.MaxBytesReader(w, req.Body, maxReqSize)
311 func jsonHandler(f interface{}) http.Handler {
312 h, err := httpjson.Handler(f, errorFormatter.Write)
320 func alwaysError(err error) http.Handler {
321 return jsonHandler(func() error { return err })
324 func webAssetsHandler(next http.Handler) http.Handler {
325 mux := http.NewServeMux()
326 mux.Handle("/dashboard/", http.StripPrefix("/dashboard/", static.Handler{
327 Assets: dashboard.Files,
328 Default: "index.html",
330 mux.Handle("/equity/", http.StripPrefix("/equity/", static.Handler{
331 Assets: equity.Files,
332 Default: "index.html",
334 mux.Handle("/", next)
339 // AuthHandler access token auth Handler
340 func AuthHandler(handler http.Handler, accessTokens *accesstoken.CredentialStore) http.Handler {
341 authenticator := authn.NewAPI(accessTokens)
343 return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
344 // TODO(tessr): check that this path exists; return early if this path isn't legit
345 req, err := authenticator.Authenticate(req)
347 log.WithField("error", errors.Wrap(err, "Serve")).Error("Authenticate fail")
348 err = errors.Sub(errNotAuthenticated, err)
349 errorFormatter.Write(req.Context(), rw, err)
352 handler.ServeHTTP(rw, req)
356 // RedirectHandler redirect to dashboard handler
357 func RedirectHandler(next http.Handler) http.Handler {
358 return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
359 if req.URL.Path == "/" {
360 http.Redirect(w, req, "/dashboard/", http.StatusFound)
363 next.ServeHTTP(w, req)
367 // latencyHandler take latency for the request url path, and redirect url path to wait-disable when wallet is closed
368 func latencyHandler(m *http.ServeMux, walletEnable bool) http.Handler {
369 return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
370 // latency for the request url path
371 if l := latency(m, req); l != nil {
372 defer l.RecordSince(time.Now())
375 // when the wallet is not been opened and the url path is not been found, modify url path to error,
376 // and redirect handler to error
377 if _, pattern := m.Handler(req); pattern != req.URL.Path && !walletEnable {
378 req.URL.Path = "/error"
379 walletRedirectHandler(w, req)
387 // walletRedirectHandler redirect to error when the wallet is closed
388 func walletRedirectHandler(w http.ResponseWriter, req *http.Request) {
389 h := http.RedirectHandler(req.URL.String(), http.StatusMovedPermanently)