blockchain/rpc/rpc.go

   1 package rpc
   2
   3 import (
   4         "bytes"
   5         "context"
   6         "encoding/json"
   7         "fmt"
   8         "io"
   9         "net/http"
  10         "net/url"
  11         "strings"
  12         "time"
  13
  14         "github.com/bytom/errors"
  15         "github.com/bytom/net/http/httperror"
  16         "github.com/bytom/net/http/reqid"
  17 )
  18
  19 // Bytom-specific header fields
  20 const (
  21         HeaderBlockchainID = "Blockchain-ID"
  22         HeaderCoreID       = "Bytom-Core-ID"
  23         HeaderTimeout      = "RPC-Timeout"
  24 )
  25
  26 // ErrWrongNetwork is returned when a peer's blockchain ID differs from
  27 // the RPC client's blockchain ID.
  28 var ErrWrongNetwork = errors.New("connected to a peer on a different network")
  29
  30 // A Client is a Bytom RPC client. It performs RPCs over HTTP using JSON
  31 // request and responses. A Client must be configured with a secret token
  32 // to authenticate with other Cores on the network.
  33 type Client struct {
  34         BaseURL      string
  35         AccessToken  string
  36         Username     string
  37         BuildTag     string
  38         BlockchainID string
  39         CoreID       string
  40
  41         // If set, Client is used for outgoing requests.
  42         // TODO(kr): make this required (crash on nil)
  43         Client *http.Client
  44 }
  45
  46 func (c Client) userAgent() string {
  47         return fmt.Sprintf("Bytom; process=%s; buildtag=%s; blockchainID=%s",
  48                 c.Username, c.BuildTag, c.BlockchainID)
  49 }
  50
  51 // ErrStatusCode is an error returned when an rpc fails with a non-200
  52 // response code.
  53 type ErrStatusCode struct {
  54         URL        string
  55         StatusCode int
  56         ErrorData  *httperror.Response
  57 }
  58
  59 func (e ErrStatusCode) Error() string {
  60         return fmt.Sprintf("Request to `%s` responded with %d %s",
  61                 e.URL, e.StatusCode, http.StatusText(e.StatusCode))
  62 }
  63
  64 // Call calls a remote procedure on another node, specified by the path.
  65 func (c *Client) Call(ctx context.Context, path string, request, response interface{}) error {
  66         r, err := c.CallRaw(ctx, path, request)
  67         if err != nil {
  68                 return err
  69         }
  70         defer r.Close()
  71         if response != nil {
  72                 err = errors.Wrap(json.NewDecoder(r).Decode(response))
  73         }
  74         return err
  75 }
  76
  77 // CallRaw calls a remote procedure on another node, specified by the path. It
  78 // returns a io.ReadCloser of the raw response body.
  79 func (c *Client) CallRaw(ctx context.Context, path string, request interface{}) (io.ReadCloser, error) {
  80         u, err := url.Parse(c.BaseURL)
  81         if err != nil {
  82                 return nil, errors.Wrap(err)
  83         }
  84         u.Path = path
  85
  86         var bodyReader io.Reader
  87         if request != nil {
  88                 var jsonBody bytes.Buffer
  89                 if err := json.NewEncoder(&jsonBody).Encode(request); err != nil {
  90                         return nil, errors.Wrap(err)
  91                 }
  92                 bodyReader = &jsonBody
  93         }
  94
  95         req, err := http.NewRequest("POST", u.String(), bodyReader)
  96         if err != nil {
  97                 return nil, errors.Wrap(err)
  98         }
  99
 100         if c.AccessToken != "" {
 101                 var username, password string
 102                 toks := strings.SplitN(c.AccessToken, ":", 2)
 103                 if len(toks) > 0 {
 104                         username = toks[0]
 105                 }
 106                 if len(toks) > 1 {
 107                         password = toks[1]
 108                 }
 109                 req.SetBasicAuth(username, password)
 110         }
 111
 112         // Propagate our request ID so that we can trace a request across nodes.
 113         req.Header.Add("Request-ID", reqid.FromContext(ctx))
 114         req.Header.Set("Content-Type", "application/json")
 115         req.Header.Set("User-Agent", c.userAgent())
 116         req.Header.Set(HeaderBlockchainID, c.BlockchainID)
 117         req.Header.Set(HeaderCoreID, c.CoreID)
 118
 119         // Propagate our deadline if we have one.
 120         deadline, ok := ctx.Deadline()
 121         if ok {
 122                 req.Header.Set(HeaderTimeout, deadline.Sub(time.Now()).String())
 123         }
 124
 125         client := c.Client
 126         if client == nil {
 127                 client = http.DefaultClient
 128         }
 129         resp, err := client.Do(req.WithContext(ctx))
 130         if err != nil && ctx.Err() != nil { // check if it timed out
 131                 return nil, errors.Wrap(ctx.Err())
 132         } else if err != nil {
 133                 return nil, errors.Wrap(err)
 134         }
 135
 136         if id := resp.Header.Get(HeaderBlockchainID); c.BlockchainID != "" && id != "" && c.BlockchainID != id {
 137                 resp.Body.Close()
 138                 return nil, errors.Wrap(ErrWrongNetwork)
 139         }
 140
 141         if resp.StatusCode < 200 || resp.StatusCode >= 300 {
 142                 defer resp.Body.Close()
 143
 144                 resErr := ErrStatusCode{
 145                         URL:        cleanedURLString(u),
 146                         StatusCode: resp.StatusCode,
 147                 }
 148
 149                 // Attach formatted error message, if available
 150                 var errData httperror.Response
 151                 err := json.NewDecoder(resp.Body).Decode(&errData)
 152                 if err == nil && errData.ChainCode != "" {
 153                         resErr.ErrorData = &errData
 154                 }
 155
 156                 return nil, resErr
 157         }
 158
 159         return resp.Body, nil
 160 }
 161
 162 func cleanedURLString(u *url.URL) string {
 163         var dup url.URL = *u
 164         dup.User = nil
 165         return dup.String()
 166 }