api/api.go

   1 package api
   2
   3 import (
   4         "crypto/tls"
   5         "net"
   6         "net/http"
   7         "sync"
   8         "time"
   9
  10         "github.com/kr/secureheader"
  11         log "github.com/sirupsen/logrus"
  12         cmn "github.com/tendermint/tmlibs/common"
  13
  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/net/websocket"
  27         "github.com/bytom/netsync"
  28         "github.com/bytom/protocol"
  29         "github.com/bytom/protocol/bc"
  30         "github.com/bytom/wallet"
  31 )
  32
  33 var (
  34         errNotAuthenticated = errors.New("not authenticated")
  35         httpReadTimeout     = 2 * time.Minute
  36         httpWriteTimeout    = time.Hour
  37 )
  38
  39 const (
  40         // SUCCESS indicates the rpc calling is successful.
  41         SUCCESS = "success"
  42         // FAIL indicated the rpc calling is failed.
  43         FAIL = "fail"
  44 )
  45
  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"`
  53 }
  54
  55 //NewSuccessResponse success response
  56 func NewSuccessResponse(data interface{}) Response {
  57         return Response{Status: SUCCESS, Data: data}
  58 }
  59
  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.
  67         defer func() {
  68                 if err := recover(); err != nil {
  69                         response.ErrorDetail = ""
  70                 }
  71         }()
  72
  73         if info, ok := respErrFormatter[root]; ok {
  74                 response.Code = info.ChainCode
  75                 response.Msg = info.Message
  76                 response.ErrorDetail = err.Error()
  77         } else {
  78                 response.Code = respErrFormatter[ErrDefault].ChainCode
  79                 response.Msg = respErrFormatter[ErrDefault].Message
  80                 response.ErrorDetail = err.Error()
  81         }
  82         return response
  83 }
  84
  85 //NewErrorResponse error response
  86 func NewErrorResponse(err error) Response {
  87         response := FormatErrResp(err)
  88         return response
  89 }
  90
  91 type waitHandler struct {
  92         h  http.Handler
  93         wg sync.WaitGroup
  94 }
  95
  96 func (wh *waitHandler) Set(h http.Handler) {
  97         wh.h = h
  98         wh.wg.Done()
  99 }
 100
 101 func (wh *waitHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 102         wh.wg.Wait()
 103         wh.h.ServeHTTP(w, req)
 104 }
 105
 106 // API is the scheduling center for server
 107 type API struct {
 108         sync            *netsync.SyncManager
 109         wallet          *wallet.Wallet
 110         accessTokens    *accesstoken.CredentialStore
 111         chain           *protocol.Chain
 112         server          *http.Server
 113         handler         http.Handler
 114         txFeedTracker   *txfeed.Tracker
 115         cpuMiner        *cpuminer.CPUMiner
 116         miningPool      *miningpool.MiningPool
 117         notificationMgr *websocket.WSNotificationManager
 118         newBlockCh      chan *bc.Hash
 119 }
 120
 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
 126
 127         coreHandler.wg.Add(1)
 128         mux := http.NewServeMux()
 129         mux.Handle("/", &coreHandler)
 130
 131         handler = AuthHandler(mux, a.accessTokens, config.Auth.Disable)
 132         handler = RedirectHandler(handler)
 133
 134         secureheader.DefaultConfig.PermitClearLoopback = true
 135         secureheader.DefaultConfig.HTTPSRedirect = false
 136         secureheader.DefaultConfig.Next = handler
 137
 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){},
 148         }
 149
 150         coreHandler.Set(a)
 151 }
 152
 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)
 157         if err != nil {
 158                 cmn.Exit(cmn.Fmt("Failed to register tcp port: %v", err))
 159         }
 160
 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
 163         // we call it.
 164         go func() {
 165                 if err := a.server.Serve(listener); err != nil {
 166                         log.WithField("error", errors.Wrap(err, "Serve")).Error("Rpc server")
 167                 }
 168         }()
 169 }
 170
 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 {
 173         api := &API{
 174                 sync:          sync,
 175                 wallet:        wallet,
 176                 chain:         chain,
 177                 accessTokens:  token,
 178                 txFeedTracker: txfeeds,
 179                 cpuMiner:      cpuMiner,
 180                 miningPool:    miningPool,
 181
 182                 newBlockCh:      newBlockCh,
 183                 notificationMgr: notificationMgr,
 184         }
 185         api.buildHandler()
 186         api.initServer(config)
 187
 188         return api
 189 }
 190
 191 func (a *API) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
 192         a.handler.ServeHTTP(rw, req)
 193 }
 194
 195 // buildHandler is in charge of all the rpc handling.
 196 func (a *API) buildHandler() {
 197         walletEnable := false
 198         m := http.NewServeMux()
 199         if a.wallet != nil {
 200                 walletEnable = true
 201
 202                 m.Handle("/create-account", jsonHandler(a.createAccount))
 203                 m.Handle("/list-accounts", jsonHandler(a.listAccounts))
 204                 m.Handle("/delete-account", jsonHandler(a.deleteAccount))
 205
 206                 m.Handle("/create-account-receiver", jsonHandler(a.createAccountReceiver))
 207                 m.Handle("/list-addresses", jsonHandler(a.listAddresses))
 208                 m.Handle("/validate-address", jsonHandler(a.validateAddress))
 209                 m.Handle("/list-pubkeys", jsonHandler(a.listPubKeys))
 210
 211                 m.Handle("/get-mining-address", jsonHandler(a.getMiningAddress))
 212                 m.Handle("/set-mining-address", jsonHandler(a.setMiningAddress))
 213
 214                 m.Handle("/get-coinbase-arbitrary", jsonHandler(a.getCoinbaseArbitrary))
 215                 m.Handle("/set-coinbase-arbitrary", jsonHandler(a.setCoinbaseArbitrary))
 216
 217                 m.Handle("/create-asset", jsonHandler(a.createAsset))
 218                 m.Handle("/update-asset-alias", jsonHandler(a.updateAssetAlias))
 219                 m.Handle("/get-asset", jsonHandler(a.getAsset))
 220                 m.Handle("/list-assets", jsonHandler(a.listAssets))
 221
 222                 m.Handle("/create-key", jsonHandler(a.pseudohsmCreateKey))
 223                 m.Handle("/list-keys", jsonHandler(a.pseudohsmListKeys))
 224                 m.Handle("/delete-key", jsonHandler(a.pseudohsmDeleteKey))
 225                 m.Handle("/reset-key-password", jsonHandler(a.pseudohsmResetPassword))
 226                 m.Handle("/check-key-password", jsonHandler(a.pseudohsmCheckPassword))
 227                 m.Handle("/sign-message", jsonHandler(a.signMessage))
 228
 229                 m.Handle("/build-transaction", jsonHandler(a.build))
 230                 m.Handle("/build-chain-transactions", jsonHandler(a.buildChainTxs))
 231                 m.Handle("/sign-transaction", jsonHandler(a.signTemplate))
 232                 m.Handle("/sign-transactions", jsonHandler(a.signTemplates))
 233
 234                 m.Handle("/get-transaction", jsonHandler(a.getTransaction))
 235                 m.Handle("/list-transactions", jsonHandler(a.listTransactions))
 236
 237                 m.Handle("/list-balances", jsonHandler(a.listBalances))
 238                 m.Handle("/list-unspent-outputs", jsonHandler(a.listUnspentOutputs))
 239
 240                 m.Handle("/decode-program", jsonHandler(a.decodeProgram))
 241
 242                 m.Handle("/backup-wallet", jsonHandler(a.backupWalletImage))
 243                 m.Handle("/restore-wallet", jsonHandler(a.restoreWalletImage))
 244                 m.Handle("/rescan-wallet", jsonHandler(a.rescanWallet))
 245                 m.Handle("/wallet-info", jsonHandler(a.getWalletInfo))
 246         } else {
 247                 log.Warn("Please enable wallet")
 248         }
 249
 250         m.Handle("/", alwaysError(errors.New("not Found")))
 251         m.Handle("/error", jsonHandler(a.walletError))
 252
 253         m.Handle("/create-access-token", jsonHandler(a.createAccessToken))
 254         m.Handle("/list-access-tokens", jsonHandler(a.listAccessTokens))
 255         m.Handle("/delete-access-token", jsonHandler(a.deleteAccessToken))
 256         m.Handle("/check-access-token", jsonHandler(a.checkAccessToken))
 257
 258         m.Handle("/create-transaction-feed", jsonHandler(a.createTxFeed))
 259         m.Handle("/get-transaction-feed", jsonHandler(a.getTxFeed))
 260         m.Handle("/update-transaction-feed", jsonHandler(a.updateTxFeed))
 261         m.Handle("/delete-transaction-feed", jsonHandler(a.deleteTxFeed))
 262         m.Handle("/list-transaction-feeds", jsonHandler(a.listTxFeeds))
 263
 264         m.Handle("/submit-transaction", jsonHandler(a.submit))
 265         m.Handle("/submit-transactions", jsonHandler(a.submitTxs))
 266         m.Handle("/estimate-transaction-gas", jsonHandler(a.estimateTxGas))
 267
 268         m.Handle("/get-unconfirmed-transaction", jsonHandler(a.getUnconfirmedTx))
 269         m.Handle("/list-unconfirmed-transactions", jsonHandler(a.listUnconfirmedTxs))
 270         m.Handle("/decode-raw-transaction", jsonHandler(a.decodeRawTransaction))
 271
 272         m.Handle("/get-block", jsonHandler(a.getBlock))
 273         m.Handle("/get-raw-block", jsonHandler(a.getRawBlock))
 274         m.Handle("/get-block-hash", jsonHandler(a.getBestBlockHash))
 275         m.Handle("/get-block-header", jsonHandler(a.getBlockHeader))
 276         m.Handle("/get-block-count", jsonHandler(a.getBlockCount))
 277         m.Handle("/get-difficulty", jsonHandler(a.getDifficulty))
 278         m.Handle("/get-hash-rate", jsonHandler(a.getHashRate))
 279
 280         m.Handle("/is-mining", jsonHandler(a.isMining))
 281         m.Handle("/set-mining", jsonHandler(a.setMining))
 282
 283         m.Handle("/get-work", jsonHandler(a.getWork))
 284         m.Handle("/get-work-json", jsonHandler(a.getWorkJSON))
 285         m.Handle("/submit-block", jsonHandler(a.submitBlock))
 286         m.Handle("/submit-work", jsonHandler(a.submitWork))
 287         m.Handle("/submit-work-json", jsonHandler(a.submitWorkJSON))
 288
 289         m.Handle("/verify-message", jsonHandler(a.verifyMessage))
 290         m.Handle("/compile", jsonHandler(a.compileEquity))
 291
 292         m.Handle("/gas-rate", jsonHandler(a.gasRate))
 293         m.Handle("/net-info", jsonHandler(a.getNetInfo))
 294
 295         m.Handle("/list-peers", jsonHandler(a.listPeers))
 296         m.Handle("/disconnect-peer", jsonHandler(a.disconnectPeer))
 297         m.Handle("/connect-peer", jsonHandler(a.connectPeer))
 298
 299         m.Handle("/get-merkle-proof", jsonHandler(a.getMerkleProof))
 300
 301         m.HandleFunc("/websocket-subscribe", a.websocketHandler)
 302
 303         handler := latencyHandler(m, walletEnable)
 304         handler = webAssetsHandler(handler)
 305         handler = gzip.Handler{Handler: handler}
 306
 307         a.handler = handler
 308 }
 309
 310 // json Handler
 311 func jsonHandler(f interface{}) http.Handler {
 312         h, err := httpjson.Handler(f, errorFormatter.Write)
 313         if err != nil {
 314                 panic(err)
 315         }
 316         return h
 317 }
 318
 319 // error Handler
 320 func alwaysError(err error) http.Handler {
 321         return jsonHandler(func() error { return err })
 322 }
 323
 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",
 329         }))
 330         mux.Handle("/equity/", http.StripPrefix("/equity/", static.Handler{
 331                 Assets:  equity.Files,
 332                 Default: "index.html",
 333         }))
 334         mux.Handle("/", next)
 335
 336         return mux
 337 }
 338
 339 // AuthHandler access token auth Handler
 340 func AuthHandler(handler http.Handler, accessTokens *accesstoken.CredentialStore, authDisable bool) http.Handler {
 341         authenticator := authn.NewAPI(accessTokens, authDisable)
 342
 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)
 346                 if err != nil {
 347                         log.WithField("error", errors.Wrap(err, "Serve")).Error("Authenticate fail")
 348                         err = errors.WithDetail(errNotAuthenticated, err.Error())
 349                         errorFormatter.Write(req.Context(), rw, err)
 350                         return
 351                 }
 352                 handler.ServeHTTP(rw, req)
 353         })
 354 }
 355
 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)
 361                         return
 362                 }
 363                 next.ServeHTTP(w, req)
 364         })
 365 }
 366
 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())
 373                 }
 374
 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)
 380                         return
 381                 }
 382
 383                 m.ServeHTTP(w, req)
 384         })
 385 }
 386
 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)
 390         h.ServeHTTP(w, req)
 391 }