// Copyright (c) 2013 Conformal Systems LLC. // Use of this source code is governed by an ISC // license that can be found in the LICENSE file. package main import ( "bytes" "code.google.com/p/go.net/websocket" "container/list" "encoding/base64" "encoding/hex" "encoding/json" "errors" "fmt" "github.com/conformal/btcchain" "github.com/conformal/btcdb" "github.com/conformal/btcjson" "github.com/conformal/btcscript" "github.com/conformal/btcutil" "github.com/conformal/btcwire" "github.com/conformal/btcws" "math/big" "net" "net/http" "strconv" "strings" "sync" "sync/atomic" ) // Errors var ( // ErrBadParamsField describes an error where the parameters JSON // field cannot be properly parsed. ErrBadParamsField = errors.New("bad params field") ) // rpcServer holds the items the rpc server may need to access (config, // shutdown, main server, etc.) type rpcServer struct { started int32 shutdown int32 server *server ws wsContext wg sync.WaitGroup rpcport string username string password string listeners []net.Listener quit chan int } // wsContext holds the items the RPC server needs to handle websocket // connections for wallets. type wsContext struct { sync.RWMutex // connections holds a map of each currently connected wallet // listener as the key. connections map[chan []byte]*requestContexts // Any chain notifications meant to be received by every connected // wallet are sent across this channel. walletNotificationMaster chan []byte // Map of address hash to list of notificationCtx. This is the global // list we actually use for notifications, we also keep a list in the // requestContexts to make removal from this list on connection close // less horrendously expensive. txNotifications map[string]*list.List // Map of outpoint to list of notificationCtx. spentNotifications map[btcwire.OutPoint]*list.List // Map of shas to list of notificationCtx. minedTxNotifications map[btcwire.ShaHash]*list.List } type notificationCtx struct { id interface{} connection chan []byte rc *requestContexts } // AddTxRequest adds the request context for new transaction notifications. func (r *wsContext) AddTxRequest(walletNotification chan []byte, rc *requestContexts, addrhash string, id interface{}) { r.Lock() defer r.Unlock() nc := ¬ificationCtx{ id: id, connection: walletNotification, rc: rc, } clist, ok := r.txNotifications[addrhash] if !ok { clist = list.New() r.txNotifications[addrhash] = clist } clist.PushBack(nc) rc.txRequests[addrhash] = id } func (r *wsContext) removeGlobalTxRequest(walletNotification chan []byte, addrhash string) { clist := r.txNotifications[addrhash] for e := clist.Front(); e != nil; e = e.Next() { ctx := e.Value.(*notificationCtx) if ctx.connection == walletNotification { clist.Remove(e) break } } if clist.Len() == 0 { delete(r.txNotifications, addrhash) } } // AddSpentRequest adds a request context for notifications of a spent // Outpoint. func (r *wsContext) AddSpentRequest(walletNotification chan []byte, rc *requestContexts, op *btcwire.OutPoint, id interface{}) { r.Lock() defer r.Unlock() nc := ¬ificationCtx{ id: id, connection: walletNotification, rc: rc, } clist, ok := r.spentNotifications[*op] if !ok { clist = list.New() r.spentNotifications[*op] = clist } clist.PushBack(nc) rc.spentRequests[*op] = id } func (r *wsContext) removeGlobalSpentRequest(walletNotification chan []byte, op *btcwire.OutPoint) { clist := r.spentNotifications[*op] for e := clist.Front(); e != nil; e = e.Next() { ctx := e.Value.(*notificationCtx) if ctx.connection == walletNotification { clist.Remove(e) break } } if clist.Len() == 0 { delete(r.spentNotifications, *op) } } // RemoveSpentRequest removes a request context for notifications of a // spent Outpoint. func (r *wsContext) RemoveSpentRequest(walletNotification chan []byte, rc *requestContexts, op *btcwire.OutPoint) { r.Lock() defer r.Unlock() r.removeGlobalSpentRequest(walletNotification, op) delete(rc.spentRequests, *op) } // AddMinedTxRequest adds request contexts for notifications of a // mined transaction. func (r *wsContext) AddMinedTxRequest(walletNotification chan []byte, txID *btcwire.ShaHash) { r.Lock() defer r.Unlock() rc := r.connections[walletNotification] nc := ¬ificationCtx{ connection: walletNotification, rc: rc, } clist, ok := r.minedTxNotifications[*txID] if !ok { clist = list.New() r.minedTxNotifications[*txID] = clist } clist.PushBack(nc) rc.minedTxRequests[*txID] = true } func (r *wsContext) removeGlobalMinedTxRequest(walletNotification chan []byte, txID *btcwire.ShaHash) { clist := r.minedTxNotifications[*txID] for e := clist.Front(); e != nil; e = e.Next() { ctx := e.Value.(*notificationCtx) if ctx.connection == walletNotification { clist.Remove(e) break } } if clist.Len() == 0 { delete(r.minedTxNotifications, *txID) } } // RemoveMinedTxRequest removes request contexts for notifications of a // mined transaction. func (r *wsContext) RemoveMinedTxRequest(walletNotification chan []byte, rc *requestContexts, txID *btcwire.ShaHash) { r.Lock() defer r.Unlock() r.removeGlobalMinedTxRequest(walletNotification, txID) delete(rc.minedTxRequests, *txID) } // CloseListeners removes all request contexts for notifications sent // to a wallet notification channel and closes the channel to stop all // goroutines currently serving that wallet. func (r *wsContext) CloseListeners(walletNotification chan []byte) { r.Lock() defer r.Unlock() delete(r.connections, walletNotification) close(walletNotification) } // requestContexts holds all requests for a single wallet connection. type requestContexts struct { // txRequests maps between a 160-byte pubkey hash and the JSON // id of the requester so replies can be correctly routed back // to the correct btcwallet callback. The key must be a stringified // address hash. txRequests map[string]interface{} // spentRequests maps between an Outpoint of an unspent // transaction output and the JSON id of the requester so // replies can be correctly routed back to the correct // btcwallet callback. spentRequests map[btcwire.OutPoint]interface{} // minedTxRequests holds a set of transaction IDs (tx hashes) of // transactions created by a wallet. A wallet may request // notifications of when a tx it created is mined into a block and // removed from the mempool. Once a tx has been mined into a // block, wallet may remove the raw transaction from its unmined tx // pool. minedTxRequests map[btcwire.ShaHash]bool } // Start is used by server.go to start the rpc listener. func (s *rpcServer) Start() { if atomic.AddInt32(&s.started, 1) != 1 { return } log.Trace("RPCS: Starting RPC server") rpcServeMux := http.NewServeMux() httpServer := &http.Server{Handler: rpcServeMux} rpcServeMux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { login := s.username + ":" + s.password auth := "Basic " + base64.StdEncoding.EncodeToString([]byte(login)) authhdr := r.Header["Authorization"] if len(authhdr) > 0 && authhdr[0] == auth { jsonRPCRead(w, r, s) } else { log.Warnf("RPCS: Auth failure.") jsonAuthFail(w, r, s) } }) go s.walletListenerDuplicator() rpcServeMux.Handle("/wallet", websocket.Handler(func(ws *websocket.Conn) { s.walletReqsNotifications(ws) })) for _, listener := range s.listeners { s.wg.Add(1) go func(listener net.Listener) { log.Infof("RPCS: RPC server listening on %s", listener.Addr()) httpServer.Serve(listener) log.Tracef("RPCS: RPC listener done for %s", listener.Addr()) s.wg.Done() }(listener) } } // Stop is used by server.go to stop the rpc listener. func (s *rpcServer) Stop() error { if atomic.AddInt32(&s.shutdown, 1) != 1 { log.Infof("RPCS: RPC server is already in the process of shutting down") return nil } log.Warnf("RPCS: RPC server shutting down") for _, listener := range s.listeners { err := listener.Close() if err != nil { log.Errorf("RPCS: Problem shutting down rpc: %v", err) return err } } log.Infof("RPCS: RPC server shutdown complete") s.wg.Wait() close(s.quit) return nil } // newRPCServer returns a new instance of the rpcServer struct. func newRPCServer(s *server) (*rpcServer, error) { rpc := rpcServer{ server: s, quit: make(chan int), } // Get values from config rpc.rpcport = cfg.RPCPort rpc.username = cfg.RPCUser rpc.password = cfg.RPCPass // initialize memory for websocket connections rpc.ws.connections = make(map[chan []byte]*requestContexts) rpc.ws.walletNotificationMaster = make(chan []byte) rpc.ws.txNotifications = make(map[string]*list.List) rpc.ws.spentNotifications = make(map[btcwire.OutPoint]*list.List) rpc.ws.minedTxNotifications = make(map[btcwire.ShaHash]*list.List) // IPv4 listener. var listeners []net.Listener listenAddr4 := net.JoinHostPort("127.0.0.1", rpc.rpcport) listener4, err := net.Listen("tcp4", listenAddr4) if err != nil { log.Errorf("RPCS: Couldn't create listener: %v", err) return nil, err } listeners = append(listeners, listener4) // IPv6 listener. listenAddr6 := net.JoinHostPort("::1", rpc.rpcport) listener6, err := net.Listen("tcp6", listenAddr6) if err != nil { log.Errorf("RPCS: Couldn't create listener: %v", err) return nil, err } listeners = append(listeners, listener6) rpc.listeners = listeners return &rpc, err } // jsonAuthFail sends a message back to the client if the http auth is rejected. func jsonAuthFail(w http.ResponseWriter, r *http.Request, s *rpcServer) { fmt.Fprint(w, "401 Unauthorized.\n") } // jsonRPCRead is the RPC wrapper around the jsonRead function to handles // reading and responding to RPC messages. func jsonRPCRead(w http.ResponseWriter, r *http.Request, s *rpcServer) { r.Close = true if atomic.LoadInt32(&s.shutdown) != 0 { return } body, err := btcjson.GetRaw(r.Body) if err != nil { log.Errorf("RPCS: Error getting json message: %v", err) return } // Error is intentionally ignored here. It's used in in the // websocket handler to tell when a method is not supported by // the standard RPC API, and is not needed here. Error logging // is done inside jsonRead, so no need to log the error here. reply, _ := jsonRead(body, s, nil) log.Tracef("[RPCS] reply: %v", reply) msg, err := btcjson.MarshallAndSend(reply, w) if err != nil { log.Errorf(msg) return } log.Debugf(msg) } // TODO(jrick): Remove the wallet notification chan. type commandHandler func(*rpcServer, btcjson.Cmd, chan []byte) (interface{}, error) var handlers = map[string]commandHandler{ "addmultisigaddress": handleAskWallet, "addnode": handleAddNode, "backupwallet": handleAskWallet, "createmultisig": handleAskWallet, "createrawtransaction": handleUnimplemented, "decoderawtransaction": handleDecodeRawTransaction, "decodescript": handleUnimplemented, "dumpprivkey": handleAskWallet, "dumpwallet": handleAskWallet, "encryptwallet": handleAskWallet, "getaccount": handleAskWallet, "getaccountaddress": handleAskWallet, "getaddednodeinfo": handleUnimplemented, "getaddressesbyaccount": handleAskWallet, "getbalance": handleAskWallet, "getbestblockhash": handleGetBestBlockHash, "getblock": handleGetBlock, "getblockcount": handleGetBlockCount, "getblockhash": handleGetBlockHash, "getblocktemplate": handleUnimplemented, "getconnectioncount": handleGetConnectionCount, "getdifficulty": handleGetDifficulty, "getgenerate": handleGetGenerate, "gethashespersec": handleGetHashesPerSec, "getinfo": handleUnimplemented, "getmininginfo": handleUnimplemented, "getnettotals": handleUnimplemented, "getnetworkhashps": handleUnimplemented, "getnewaddress": handleUnimplemented, "getpeerinfo": handleGetPeerInfo, "getrawchangeaddress": handleAskWallet, "getrawmempool": handleGetRawMempool, "getrawtransaction": handleGetRawTransaction, "getreceivedbyaccount": handleAskWallet, "getreceivedbyaddress": handleAskWallet, "gettransaction": handleAskWallet, "gettxout": handleAskWallet, "gettxoutsetinfo": handleAskWallet, "getwork": handleUnimplemented, "help": handleUnimplemented, "importprivkey": handleAskWallet, "importwallet": handleAskWallet, "keypoolrefill": handleAskWallet, "listaccounts": handleAskWallet, "listaddressgroupings": handleAskWallet, "listlockunspent": handleAskWallet, "listreceivedbyaccount": handleAskWallet, "listreceivedbyaddress": handleAskWallet, "listsinceblock": handleAskWallet, "listtransactions": handleAskWallet, "listunspent": handleAskWallet, "lockunspent": handleAskWallet, "move": handleAskWallet, "ping": handleUnimplemented, "sendfrom": handleAskWallet, "sendmany": handleAskWallet, "sendrawtransaction": handleSendRawTransaction, "sendtoaddress": handleAskWallet, "setaccount": handleAskWallet, "setgenerate": handleSetGenerate, "settxfee": handleAskWallet, "signmessage": handleAskWallet, "signrawtransaction": handleAskWallet, "stop": handleStop, "submitblock": handleUnimplemented, "validateaddress": handleAskWallet, "verifychain": handleUnimplemented, "verifymessage": handleAskWallet, "walletlock": handleAskWallet, "walletpassphrase": handleAskWallet, "walletpassphrasechange": handleAskWallet, } type wsCommandHandler func(*rpcServer, btcjson.Cmd, chan []byte, *requestContexts) error var wsHandlers = map[string]wsCommandHandler{ "getcurrentnet": handleGetCurrentNet, "getbestblock": handleGetBestBlock, "rescan": handleRescan, "notifynewtxs": handleNotifyNewTXs, "notifyspent": handleNotifySpent, } // handleUnimplemented is a temporary handler for commands that we should // support but do not. func handleUnimplemented(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { return nil, btcjson.ErrUnimplemented } // handleAskWallet is the handler for commands that we do recognise as valid // but that we can not answer correctly since it involves wallet state. // These commands will be implemented in btcwallet. func handleAskWallet(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { return nil, btcjson.ErrNoWallet } // handleDecodeRawTransaction handles decoderawtransaction commands. func handleAddNode(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { c := cmd.(*btcjson.AddNodeCmd) addr := normalizePeerAddress(c.Addr) var err error switch c.SubCmd { case "add": err = s.server.AddAddr(addr, true) case "remove": err = s.server.RemoveAddr(addr) case "onetry": err = s.server.AddAddr(addr, false) default: err = errors.New("Invalid subcommand for addnode") } // no data returned unless an error. return nil, err } // handleDecodeRawTransaction handles decoderawtransaction commands. func handleDecodeRawTransaction(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { // TODO: use c.HexTx and fill result with info. return btcjson.TxRawDecodeResult{}, nil } // handleGetBestBlockHash implements the getbestblockhash command. func handleGetBestBlockHash(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { var sha *btcwire.ShaHash sha, _, err := s.server.db.NewestSha() if err != nil { log.Errorf("RPCS: Error getting newest sha: %v", err) return nil, btcjson.ErrBestBlockHash } return sha.String(), nil } // handleGetBlock implements the getblock command. func handleGetBlock(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { c := cmd.(*btcjson.GetBlockCmd) sha, err := btcwire.NewShaHashFromStr(c.Hash) if err != nil { log.Errorf("RPCS: Error generating sha: %v", err) return nil, btcjson.ErrBlockNotFound } blk, err := s.server.db.FetchBlockBySha(sha) if err != nil { log.Errorf("RPCS: Error fetching sha: %v", err) return nil, btcjson.ErrBlockNotFound } idx := blk.Height() buf, err := blk.Bytes() if err != nil { log.Errorf("RPCS: Error fetching block: %v", err) return nil, btcjson.ErrBlockNotFound } txList, _ := blk.TxShas() txNames := make([]string, len(txList)) for i, v := range txList { txNames[i] = v.String() } _, maxidx, err := s.server.db.NewestSha() if err != nil { log.Errorf("RPCS: Cannot get newest sha: %v", err) return nil, btcjson.ErrBlockNotFound } blockHeader := &blk.MsgBlock().Header blockReply := btcjson.BlockResult{ Hash: c.Hash, Version: blockHeader.Version, MerkleRoot: blockHeader.MerkleRoot.String(), PreviousHash: blockHeader.PrevBlock.String(), Nonce: blockHeader.Nonce, Time: blockHeader.Timestamp.Unix(), Confirmations: uint64(1 + maxidx - idx), Height: idx, Tx: txNames, Size: len(buf), Bits: strconv.FormatInt(int64(blockHeader.Bits), 16), Difficulty: getDifficultyRatio(blockHeader.Bits), } // Get next block unless we are already at the top. if idx < maxidx { var shaNext *btcwire.ShaHash shaNext, err = s.server.db.FetchBlockShaByHeight(int64(idx + 1)) if err != nil { log.Errorf("RPCS: No next block: %v", err) return nil, btcjson.ErrBlockNotFound } blockReply.NextHash = shaNext.String() } return blockReply, nil } // handleGetBlockCount implements the getblockcount command. func handleGetBlockCount(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { _, maxidx, err := s.server.db.NewestSha() if err != nil { log.Errorf("RPCS: Error getting newest sha: %v", err) return nil, btcjson.ErrBlockCount } return maxidx, nil } // handleGetBlockHash implements the getblockhash command. func handleGetBlockHash(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { c := cmd.(*btcjson.GetBlockHashCmd) sha, err := s.server.db.FetchBlockShaByHeight(c.Index) if err != nil { log.Errorf("[RCPS] Error getting block: %v", err) return nil, btcjson.ErrOutOfRange } return sha.String(), nil } // handleGetConnectionCount implements the getconnectioncount command. func handleGetConnectionCount(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { return s.server.ConnectedCount(), nil } // handleGetDifficulty implements the getdifficulty command. func handleGetDifficulty(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { sha, _, err := s.server.db.NewestSha() if err != nil { log.Errorf("RPCS: Error getting sha: %v", err) return nil, btcjson.ErrDifficulty } blk, err := s.server.db.FetchBlockBySha(sha) if err != nil { log.Errorf("RPCS: Error getting block: %v", err) return nil, btcjson.ErrDifficulty } blockHeader := &blk.MsgBlock().Header return getDifficultyRatio(blockHeader.Bits), nil } // handleGetGenerate implements the getgenerate command. func handleGetGenerate(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { // btcd does not do mining so we can hardcode replies here. return false, nil } // handleGetHashesPerSec implements the gethashespersec command. func handleGetHashesPerSec(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { // btcd does not do mining so we can hardcode replies here. return 0, nil } // handleGetPeerInfo implements the getpeerinfo command. func handleGetPeerInfo(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { return s.server.PeerInfo(), nil } // handleGetRawMempool implements the getrawmempool command. func handleGetRawMempool(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { hashes := s.server.txMemPool.TxShas() hashStrings := make([]string, len(hashes)) for i := 0; i < len(hashes); i++ { hashStrings[i] = hashes[i].String() } return hashStrings, nil } // handleGetRawTransaction implements the getrawtransaction command. func handleGetRawTransaction(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { c := cmd.(*btcjson.GetRawTransactionCmd) if c.Verbose { // TODO: check error code. tx is not checked before // this point. txSha, _ := btcwire.NewShaHashFromStr(c.Txid) txList, err := s.server.db.FetchTxBySha(txSha) if err != nil { log.Errorf("RPCS: Error fetching tx: %v", err) return nil, btcjson.ErrNoTxInfo } lastTx := len(txList) - 1 txS := txList[lastTx].Tx blksha := txList[lastTx].BlkSha blk, err := s.server.db.FetchBlockBySha(blksha) if err != nil { log.Errorf("RPCS: Error fetching sha: %v", err) return nil, btcjson.ErrBlockNotFound } idx := blk.Height() txOutList := txS.TxOut voutList := make([]btcjson.Vout, len(txOutList)) txInList := txS.TxIn vinList := make([]btcjson.Vin, len(txInList)) for i, v := range txInList { vinList[i].Sequence = float64(v.Sequence) disbuf, _ := btcscript.DisasmString(v.SignatureScript) vinList[i].ScriptSig.Asm = strings.Replace(disbuf, " ", "", -1) vinList[i].Vout = i + 1 log.Debugf(disbuf) } for i, v := range txOutList { voutList[i].N = i voutList[i].Value = float64(v.Value) / 100000000 isbuf, _ := btcscript.DisasmString(v.PkScript) voutList[i].ScriptPubKey.Asm = isbuf voutList[i].ScriptPubKey.ReqSig = strings.Count(isbuf, "OP_CHECKSIG") _, addrhash, err := btcscript.ScriptToAddrHash(v.PkScript) if err != nil { // TODO: set and return error? log.Errorf("RPCS: Error getting address hash for %v: %v", txSha, err) } if addr, err := btcutil.EncodeAddress(addrhash, s.server.btcnet); err != nil { // TODO: set and return error? addrList := make([]string, 1) addrList[0] = addr voutList[i].ScriptPubKey.Addresses = addrList } } _, maxidx, err := s.server.db.NewestSha() if err != nil { log.Errorf("RPCS: Cannot get newest sha: %v", err) return nil, btcjson.ErrNoNewestBlockInfo } confirmations := uint64(1 + maxidx - idx) blockHeader := &blk.MsgBlock().Header txReply := btcjson.TxRawResult{ Txid: c.Txid, Vout: voutList, Vin: vinList, Version: txS.Version, LockTime: txS.LockTime, // This is not a typo, they are identical in // bitcoind as well. Time: blockHeader.Timestamp.Unix(), Blocktime: blockHeader.Timestamp.Unix(), BlockHash: blksha.String(), Confirmations: confirmations, } return txReply, nil } else { // Don't return details // not used yet return nil, nil } } // handleSendRawTransaction implements the sendrawtransaction command. func handleSendRawTransaction(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { c := cmd.(*btcjson.SendRawTransactionCmd) // Deserialize and send off to tx relay serializedTx, err := hex.DecodeString(c.HexTx) if err != nil { return nil, btcjson.ErrDecodeHexString } msgtx := btcwire.NewMsgTx() err = msgtx.Deserialize(bytes.NewBuffer(serializedTx)) if err != nil { err := btcjson.Error{ Code: btcjson.ErrDeserialization.Code, Message: "TX decode failed", } return nil, err } tx := btcutil.NewTx(msgtx) err = s.server.txMemPool.ProcessTransaction(tx) if err != nil { // When the error is a rule error, it means the transaction was // simply rejected as opposed to something actually going wrong, // so log it as such. Otherwise, something really did go wrong, // so log it as an actual error. if _, ok := err.(TxRuleError); ok { log.Debugf("RPCS: Rejected transaction %v: %v", tx.Sha(), err) } else { log.Errorf("RPCS: Failed to process transaction %v: %v", tx.Sha(), err) err = btcjson.Error{ Code: btcjson.ErrDeserialization.Code, Message: "TX rejected", } return nil, err } } // If called from websocket code, add a mined tx hashes // request. if walletNotification != nil { s.ws.AddMinedTxRequest(walletNotification, tx.Sha()) } return tx.Sha().String(), nil } // handleSetGenerate implements the setgenerate command. func handleSetGenerate(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { // btcd does not do mining so we can hardcode replies here. return nil, nil } // handleStop implements the stop command. func handleStop(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte) (interface{}, error) { s.server.Stop() return "btcd stopping.", nil } // jsonRead abstracts the JSON unmarshalling and reply handling used // by both RPC and websockets. If called from websocket code, a non-nil // wallet notification channel can be used to automatically register // various notifications for the wallet. func jsonRead(body []byte, s *rpcServer, walletNotification chan []byte) (reply btcjson.Reply, err error) { cmd, err := btcjson.ParseMarshaledCmd(body) if err != nil { var id interface{} if cmd != nil { // Unmarshaling a valid JSON-RPC message succeeded. Use // the provided id for errors. id = cmd.Id() } if jsonErr, ok := err.(btcjson.Error); ok { reply = btcjson.Reply{ Result: nil, Error: &jsonErr, Id: &id, } } else { reply = btcjson.Reply{ Result: nil, Error: &jsonErr, Id: &id, } } log.Tracef("RPCS: reply: %v", reply) return reply, err } log.Tracef("RPCS: received: %v", cmd) id := cmd.Id() handler, ok := handlers[cmd.Method()] if !ok { reply = btcjson.Reply{ Result: nil, Error: &btcjson.ErrMethodNotFound, Id: &id, } return reply, btcjson.ErrMethodNotFound } result, err := handler(s, cmd, walletNotification) if err != nil { if jsonErr, ok := err.(btcjson.Error); ok { reply = btcjson.Reply{ Error: &jsonErr, Id: &id, } err = errors.New(jsonErr.Message) } else { // In the case where we did not have a btcjson // error to begin with, make a new one to send, // but this really should not happen. rawJSONError := btcjson.Error{ Code: btcjson.ErrInternal.Code, Message: err.Error(), } reply = btcjson.Reply{ Error: &rawJSONError, Id: &id, } } } else { reply = btcjson.Reply{ Result: result, Id: &id, } } return reply, err } // handleGetCurrentNet implements the getcurrentnet command extension // for websocket connections. func handleGetCurrentNet(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte, rc *requestContexts) error { id := cmd.Id() reply := &btcjson.Reply{Id: &id} var net btcwire.BitcoinNet if cfg.TestNet3 { net = btcwire.TestNet3 } else { net = btcwire.MainNet } reply.Result = float64(net) mreply, _ := json.Marshal(reply) walletNotification <- mreply return nil } // handleGetBestBlock implements the getbestblock command extension // for websocket connections. func handleGetBestBlock(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte, rc *requestContexts) error { id := cmd.Id() reply := &btcjson.Reply{Id: &id} // All other "get block" commands give either the height, the // hash, or both but require the block SHA. This gets both for // the best block. sha, height, err := s.server.db.NewestSha() if err != nil { return btcjson.ErrBestBlockHash } reply.Result = map[string]interface{}{ "hash": sha.String(), "height": height, } mreply, _ := json.Marshal(reply) walletNotification <- mreply return nil } // handleRescan implements the rescan command extension for websocket // connections. func handleRescan(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte, rc *requestContexts) error { id := cmd.Id() reply := &btcjson.Reply{Id: &id} rescanCmd, ok := cmd.(*btcws.RescanCmd) if !ok { return btcjson.ErrInternal } log.Debugf("RPCS: Begining rescan") minblock := int64(rescanCmd.BeginBlock) maxblock := int64(rescanCmd.EndBlock) // FetchHeightRange may not return a complete list of block shas for // the given range, so fetch range as many times as necessary. for { blkshalist, err := s.server.db.FetchHeightRange(minblock, maxblock) if err != nil { return err } if len(blkshalist) == 0 { break } for i := range blkshalist { blk, err := s.server.db.FetchBlockBySha(&blkshalist[i]) if err != nil { return err } txShaList, err := blk.TxShas() if err != nil { return err } txList := s.server.db.FetchTxByShaList(txShaList) for _, txReply := range txList { if txReply.Err != nil || txReply.Tx == nil { continue } for txOutIdx, txout := range txReply.Tx.TxOut { st, txaddrhash, err := btcscript.ScriptToAddrHash(txout.PkScript) if st != btcscript.ScriptAddr || err != nil { continue } txaddr, err := btcutil.EncodeAddress(txaddrhash, s.server.btcnet) if err != nil { log.Errorf("Error encoding address: %v", err) return err } if _, ok := rescanCmd.Addresses[txaddr]; ok { reply.Result = struct { Sender string `json:"sender"` Receiver string `json:"receiver"` BlockHash string `json:"blockhash"` Height int64 `json:"height"` TxHash string `json:"txhash"` Index uint32 `json:"index"` Amount int64 `json:"amount"` PkScript string `json:"pkscript"` Spent bool `json:"spent"` }{ Sender: "Unknown", // TODO(jrick) Receiver: txaddr, BlockHash: blkshalist[i].String(), Height: blk.Height(), TxHash: txReply.Sha.String(), Index: uint32(txOutIdx), Amount: txout.Value, PkScript: btcutil.Base58Encode(txout.PkScript), Spent: txReply.TxSpent[txOutIdx], } mreply, _ := json.Marshal(reply) walletNotification <- mreply } } } } if maxblock-minblock > int64(len(blkshalist)) { minblock += int64(len(blkshalist)) } else { break } } mreply, _ := json.Marshal(reply) walletNotification <- mreply log.Debug("RPCS: Finished rescan") return nil } // handleNotifyNewTXs implements the notifynewtxs command extension for // websocket connections. func handleNotifyNewTXs(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte, rc *requestContexts) error { id := cmd.Id() reply := &btcjson.Reply{Id: &id} notifyCmd, ok := cmd.(*btcws.NotifyNewTXsCmd) if !ok { return btcjson.ErrInternal } for _, addr := range notifyCmd.Addresses { hash, _, err := btcutil.DecodeAddress(addr) if err != nil { return fmt.Errorf("cannot decode address: %v", err) } s.ws.AddTxRequest(walletNotification, rc, string(hash), cmd.Id()) } mreply, _ := json.Marshal(reply) walletNotification <- mreply return nil } // handleNotifySpent implements the notifyspent command extension for // websocket connections. func handleNotifySpent(s *rpcServer, cmd btcjson.Cmd, walletNotification chan []byte, rc *requestContexts) error { id := cmd.Id() reply := &btcjson.Reply{Id: &id} notifyCmd, ok := cmd.(*btcws.NotifySpentCmd) if !ok { return btcjson.ErrInternal } s.ws.AddSpentRequest(walletNotification, rc, notifyCmd.OutPoint, cmd.Id()) mreply, _ := json.Marshal(reply) walletNotification <- mreply return nil } func jsonWSRead(body []byte, s *rpcServer, walletNotification chan []byte, rc *requestContexts) error { var reply btcjson.Reply cmd, err := btcjson.ParseMarshaledCmd(body) if err != nil { if cmd != nil { // Unmarshaling a valid JSON-RPC message succeeded. Use // the provided id for errors. id := cmd.Id() reply.Id = &id } jsonErr, ok := err.(btcjson.Error) if !ok { jsonErr = btcjson.Error{ Code: btcjson.ErrMisc.Code, Message: err.Error(), } } reply.Error = &jsonErr mreply, _ := json.Marshal(reply) walletNotification <- mreply return err } id := cmd.Id() reply.Id = &id wsHandler, ok := wsHandlers[cmd.Method()] if !ok { reply.Error = &btcjson.ErrMethodNotFound mreply, _ := json.Marshal(reply) walletNotification <- mreply return btcjson.ErrMethodNotFound } if err := wsHandler(s, cmd, walletNotification, rc); err != nil { jsonErr, ok := err.(btcjson.Error) if ok { reply.Error = &jsonErr mreply, _ := json.Marshal(reply) walletNotification <- mreply return errors.New(jsonErr.Message) } // In the case where we did not have a btcjson // error to begin with, make a new one to send, // but this really should not happen. jsonErr = btcjson.Error{ Code: btcjson.ErrInternal.Code, Message: err.Error(), } reply.Error = &jsonErr mreply, _ := json.Marshal(reply) walletNotification <- mreply return err } return nil } // getDifficultyRatio returns the proof-of-work difficulty as a multiple of the // minimum difficulty using the passed bits field from the header of a block. func getDifficultyRatio(bits uint32) float64 { // The minimum difficulty is the max possible proof-of-work limit bits // converted back to a number. Note this is not the same as the the // proof of work limit directly because the block difficulty is encoded // in a block with the compact form which loses precision. max := btcchain.CompactToBig(activeNetParams.powLimitBits) target := btcchain.CompactToBig(bits) difficulty := new(big.Rat).SetFrac(max, target) outString := difficulty.FloatString(2) diff, err := strconv.ParseFloat(outString, 64) if err != nil { log.Errorf("RPCS: Cannot get difficulty: %v", err) return 0 } return diff } // AddWalletListener adds a channel to listen for new messages from a // wallet. func (s *rpcServer) AddWalletListener(c chan []byte) *requestContexts { s.ws.Lock() rc := &requestContexts{ // The key is a stringified addressHash. txRequests: make(map[string]interface{}), spentRequests: make(map[btcwire.OutPoint]interface{}), minedTxRequests: make(map[btcwire.ShaHash]bool), } s.ws.connections[c] = rc s.ws.Unlock() return rc } // RemoveWalletListener removes a wallet listener channel. func (s *rpcServer) RemoveWalletListener(c chan []byte, rc *requestContexts) { s.ws.Lock() for k := range rc.txRequests { s.ws.removeGlobalTxRequest(c, k) } for k := range rc.spentRequests { s.ws.removeGlobalSpentRequest(c, &k) } for k := range rc.minedTxRequests { s.ws.removeGlobalMinedTxRequest(c, &k) } delete(s.ws.connections, c) s.ws.Unlock() } // walletListenerDuplicator listens for new wallet listener channels // and duplicates messages sent to walletNotificationMaster to all // connected listeners. func (s *rpcServer) walletListenerDuplicator() { // Duplicate all messages sent across walletNotificationMaster to each // listening wallet. for { select { case ntfn := <-s.ws.walletNotificationMaster: s.ws.RLock() for c := range s.ws.connections { c <- ntfn } s.ws.RUnlock() case <-s.quit: return } } } // walletReqsNotifications is the handler function for websocket // connections from a btcwallet instance. It reads messages from wallet and // sends back replies, as well as notififying wallets of chain updates. func (s *rpcServer) walletReqsNotifications(ws *websocket.Conn) { // Add wallet notification channel so this handler receives btcd chain // notifications. c := make(chan []byte) rc := s.AddWalletListener(c) defer s.RemoveWalletListener(c, rc) // msgs is a channel for all messages received over the websocket. msgs := make(chan []byte) // Receive messages from websocket and send across reqs until the // connection is lost. go func() { for { select { case <-s.quit: close(msgs) return default: var m []byte if err := websocket.Message.Receive(ws, &m); err != nil { close(msgs) return } msgs <- m } } }() for { select { case m, ok := <-msgs: if !ok { // Wallet disconnected. return } // Handle request here. go s.websocketJSONHandler(c, rc, m) case ntfn, _ := <-c: // Send btcd notification to btcwallet instance over // websocket. if err := websocket.Message.Send(ws, ntfn); err != nil { // Wallet disconnected. return } case <-s.quit: // Server closed. return } } } // websocketJSONHandler parses and handles a marshalled json message, // sending the marshalled reply to a wallet notification channel. func (s *rpcServer) websocketJSONHandler(walletNotification chan []byte, rc *requestContexts, msg []byte) { s.wg.Add(1) reply, err := jsonRead(msg, s, walletNotification) s.wg.Done() if err != btcjson.ErrMethodNotFound { replyBytes, err := json.Marshal(reply) if err != nil { log.Errorf("RPCS: Error marshalling reply: %v", err) } walletNotification <- replyBytes return } // Try websocket extensions s.wg.Add(1) err = jsonWSRead(msg, s, walletNotification, rc) s.wg.Done() } // NotifyBlockConnected creates and marshalls a JSON message to notify // of a new block connected to the main chain. The notification is sent // to each connected wallet. func (s *rpcServer) NotifyBlockConnected(block *btcutil.Block) { s.ws.RLock() hash, err := block.Sha() if err != nil { log.Error("Bad block; connected block notification dropped.") return } var id interface{} = "btcd:blockconnected" ntfn := btcjson.Reply{ Result: struct { Hash string `json:"hash"` Height int64 `json:"height"` MinedTXs []string `json:"minedtxs"` }{ Hash: hash.String(), Height: block.Height(), }, Id: &id, } m, _ := json.Marshal(ntfn) s.ws.walletNotificationMaster <- m // Inform any interested parties about txs mined in this block. for _, tx := range block.Transactions() { if clist, ok := s.ws.minedTxNotifications[*tx.Sha()]; ok { for e := clist.Front(); e != nil; e = e.Next() { ctx := e.Value.(*notificationCtx) var id interface{} = "btcd:txmined" reply := btcjson.Reply{ Result: tx.Sha().String(), Id: &id, } replyBytes, err := json.Marshal(reply) if err != nil { log.Errorf("RPCS: Unable to marshal mined tx notification: %v", err) continue } ctx.connection <- replyBytes s.ws.RemoveMinedTxRequest(ctx.connection, ctx.rc, tx.Sha()) } } } s.ws.RUnlock() } // NotifyBlockDisconnected creates and marshals a JSON message to notify // of a new block disconnected from the main chain. The notification is sent // to each connected wallet. func (s *rpcServer) NotifyBlockDisconnected(block *btcutil.Block) { var id interface{} = "btcd:blockdisconnected" hash, err := block.Sha() if err != nil { log.Error("Bad block; connected block notification dropped.") return } ntfn := btcjson.Reply{ Result: struct { Hash string `json:"hash"` Height int64 `json:"height"` }{ Hash: hash.String(), Height: block.Height(), }, Id: &id, } m, _ := json.Marshal(ntfn) s.ws.walletNotificationMaster <- m } // NotifyBlockTXs creates and marshals a JSON message to notify wallets // of new transactions (with both spent and unspent outputs) for a watched // address. func (s *rpcServer) NotifyBlockTXs(db btcdb.Db, block *btcutil.Block) { for _, tx := range block.Transactions() { s.newBlockNotifyCheckTxIn(tx) s.newBlockNotifyCheckTxOut(block, tx) } } func notifySpentData(ctx *notificationCtx, txhash *btcwire.ShaHash, index uint32, spender *btcutil.Tx) { txStr := "" if spender != nil { var buf bytes.Buffer err := spender.MsgTx().Serialize(&buf) if err != nil { // This really shouldn't ever happen... log.Warnf("RPCS: Can't serialize tx: %v", err) return } txStr = string(buf.Bytes()) } reply := &btcjson.Reply{ Result: struct { TxHash string `json:"txhash"` Index uint32 `json:"index"` SpendingTx string `json:"spender,omitempty"` }{ TxHash: txhash.String(), Index: index, SpendingTx: txStr, }, Error: nil, Id: &ctx.id, } replyBytes, err := json.Marshal(reply) if err != nil { log.Errorf("RPCS: Unable to marshal spent notification: %v", err) return } ctx.connection <- replyBytes } // newBlockNotifyCheckTxIn is a helper function to iterate through // each transaction input of a new block and perform any checks and // notify listening frontends when necessary. func (s *rpcServer) newBlockNotifyCheckTxIn(tx *btcutil.Tx) { for _, txin := range tx.MsgTx().TxIn { if clist, ok := s.ws.spentNotifications[txin.PreviousOutpoint]; ok { for e := clist.Front(); e != nil; e = e.Next() { ctx := e.Value.(*notificationCtx) notifySpentData(ctx, &txin.PreviousOutpoint.Hash, uint32(txin.PreviousOutpoint.Index), tx) s.ws.RemoveSpentRequest(ctx.connection, ctx.rc, &txin.PreviousOutpoint) } } } } // newBlockNotifyCheckTxOut is a helper function to iterate through // each transaction output of a new block and perform any checks and // notify listening frontends when necessary. func (s *rpcServer) newBlockNotifyCheckTxOut(block *btcutil.Block, tx *btcutil.Tx) { for i, txout := range tx.MsgTx().TxOut { _, txaddrhash, err := btcscript.ScriptToAddrHash(txout.PkScript) if err != nil { log.Debug("Error getting payment address from tx; dropping any Tx notifications.") break } if idlist, ok := s.ws.txNotifications[string(txaddrhash)]; ok { for e := idlist.Front(); e != nil; e = e.Next() { ctx := e.Value.(*notificationCtx) blkhash, err := block.Sha() if err != nil { log.Error("Error getting block sha; dropping Tx notification.") break } txaddr, err := btcutil.EncodeAddress(txaddrhash, s.server.btcnet) if err != nil { log.Error("Error encoding address; dropping Tx notification.") break } reply := &btcjson.Reply{ Result: struct { Sender string `json:"sender"` Receiver string `json:"receiver"` BlockHash string `json:"blockhash"` Height int64 `json:"height"` TxHash string `json:"txhash"` Index uint32 `json:"index"` Amount int64 `json:"amount"` PkScript string `json:"pkscript"` }{ Sender: "Unknown", // TODO(jrick) Receiver: txaddr, BlockHash: blkhash.String(), Height: block.Height(), TxHash: tx.Sha().String(), Index: uint32(i), Amount: txout.Value, PkScript: btcutil.Base58Encode(txout.PkScript), }, Error: nil, Id: &ctx.id, } replyBytes, err := json.Marshal(reply) if err != nil { log.Errorf("RPCS: Unable to marshal tx notification: %v", err) continue } ctx.connection <- replyBytes } } } }