lbcwallet/cmdmgr.go

/*
 * Copyright (c) 2013 Conformal Systems LLC <info@conformal.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package main

import (
	"encoding/hex"
	"encoding/json"
	"fmt"
	"github.com/conformal/btcjson"
	"github.com/conformal/btcwallet/wallet"
	"github.com/conformal/btcwire"
	"sync"
	"time"
)

// Standard JSON-RPC 2.0 errors
var (
	InvalidRequest = btcjson.Error{
		Code:    -32600,
		Message: "Invalid request",
	}
	MethodNotFound = btcjson.Error{
		Code:    -32601,
		Message: "Method not found",
	}
	InvalidParams = btcjson.Error{
		Code:    -32602,
		Message: "Invalid paramaters",
	}
	InternalError = btcjson.Error{
		Code:    -32603,
		Message: "Internal error",
	}
	ParseError = btcjson.Error{
		Code:    -32700,
		Message: "Parse error",
	}
)

// General application defined JSON errors
var (
	MiscError = btcjson.Error{
		Code:    -1,
		Message: "Miscellaneous error",
	}
	ForbiddenBySafeMode = btcjson.Error{
		Code:    -2,
		Message: "Server is in safe mode, and command is not allowed in safe mode",
	}
	TypeError = btcjson.Error{
		Code:    -3,
		Message: "Unexpected type was passed as parameter",
	}
	InvalidAddressOrKey = btcjson.Error{
		Code:    -5,
		Message: "Invalid address or key",
	}
	OutOfMemory = btcjson.Error{
		Code:    -7,
		Message: "Ran out of memory during operation",
	}
	InvalidParameter = btcjson.Error{
		Code:    -8,
		Message: "Invalid, missing or duplicate parameter",
	}
	DatabaseError = btcjson.Error{
		Code:    -20,
		Message: "Database error",
	}
	DeserializationError = btcjson.Error{
		Code:    -22,
		Message: "Error parsing or validating structure in raw format",
	}
)

// Wallet JSON errors
var (
	WalletError = btcjson.Error{
		Code:    -4,
		Message: "Unspecified problem with wallet",
	}
	WalletInsufficientFunds = btcjson.Error{
		Code:    -6,
		Message: "Not enough funds in wallet or account",
	}
	WalletInvalidAccountName = btcjson.Error{
		Code:    -11,
		Message: "Invalid account name",
	}
	WalletKeypoolRanOut = btcjson.Error{
		Code:    -12,
		Message: "Keypool ran out, call keypoolrefill first",
	}
	WalletUnlockNeeded = btcjson.Error{
		Code:    -13,
		Message: "Enter the wallet passphrase with walletpassphrase first",
	}
	WalletPassphraseIncorrect = btcjson.Error{
		Code:    -14,
		Message: "The wallet passphrase entered was incorrect",
	}
	WalletWrongEncState = btcjson.Error{
		Code:    -15,
		Message: "Command given in wrong wallet encryption state",
	}
	WalletEncryptionFailed = btcjson.Error{
		Code:    -16,
		Message: "Failed to encrypt the wallet",
	}
	WalletAlreadyUnlocked = btcjson.Error{
		Code:    -17,
		Message: "Wallet is already unlocked",
	}
)

var (
	// seq holds the btcwallet sequence number for frontend messages
	// which must be sent to and received from btcd.  A Mutex protects
	// against concurrent access.
	seq = struct {
		sync.Mutex
		n uint64
	}{}

	// replyRouter maps uint64 ids to reply channels, so btcd replies can
	// be routed to the correct frontend.
	replyRouter = struct {
		sync.Mutex
		m map[uint64]chan []byte
	}{
		m: make(map[uint64]chan []byte),
	}
)

// ProcessFrontendMsg checks the message sent from a frontend.  If the
// message method is one that must be handled by btcwallet, the request
// is processed here.  Otherwise, the message is sent to btcd.
func ProcessFrontendMsg(reply chan []byte, msg []byte) {
	var jsonMsg btcjson.Message
	if err := json.Unmarshal(msg, &jsonMsg); err != nil {
		log.Errorf("ProcessFrontendMsg: Cannot unmarshal message: %v",
			err)
		return
	}

	switch jsonMsg.Method {
	// Standard bitcoind methods
	case "getaddressesbyaccount":
		GetAddressesByAccount(reply, &jsonMsg)
	case "getbalance":
		GetBalance(reply, &jsonMsg)
	case "getnewaddress":
		GetNewAddress(reply, &jsonMsg)
	case "sendfrom":
		SendFrom(reply, &jsonMsg)
	case "sendmany":
		SendMany(reply, &jsonMsg)
	case "settxfee":
		SetTxFee(reply, &jsonMsg)
	case "walletlock":
		WalletLock(reply, &jsonMsg)
	case "walletpassphrase":
		WalletPassphrase(reply, &jsonMsg)

	// btcwallet extensions
	case "createencryptedwallet":
		CreateEncryptedWallet(reply, &jsonMsg)
	case "walletislocked":
		WalletIsLocked(reply, &jsonMsg)
	case "btcdconnected":
		BtcdConnected(reply, &jsonMsg)

	default:
		// btcwallet does not understand method.  Pass to btcd.
		seq.Lock()
		n := seq.n
		seq.n++
		seq.Unlock()

		var id interface{} = fmt.Sprintf("btcwallet(%v)-%v", n,
			jsonMsg.Id)
		jsonMsg.Id = &id
		newMsg, err := json.Marshal(jsonMsg)
		if err != nil {
			log.Errorf("ProcessFrontendMsg: Cannot marshal message: %v",
				err)
			return
		}
		replyRouter.Lock()
		replyRouter.m[n] = reply
		replyRouter.Unlock()
		btcdMsgs <- newMsg
	}
}

// ReplyError creates and marshalls a btcjson.Reply with the error e,
// sending the reply to a reply channel.
func ReplyError(reply chan []byte, id interface{}, e *btcjson.Error) {
	r := btcjson.Reply{
		Error: e,
		Id:    &id,
	}
	if mr, err := json.Marshal(r); err == nil {
		reply <- mr
	} else {
		log.Errorf("Cannot marshal json reply: %v", err)
	}
}

// ReplySuccess creates and marshalls a btcjson.Reply with the result r,
// sending the reply to a reply channel.
func ReplySuccess(reply chan []byte, id interface{}, result interface{}) {
	r := btcjson.Reply{
		Result: result,
		Id:     &id,
	}
	if mr, err := json.Marshal(r); err == nil {
		reply <- mr
	}
}

// GetAddressesByAccount replies with all addresses for an account.
func GetAddressesByAccount(reply chan []byte, msg *btcjson.Message) {
	e := InvalidParams

	// TODO(jrick): check if we can make btcjson.Message.Params
	// a []interface{} to avoid this.
	params, ok := msg.Params.([]interface{})
	if !ok {
		ReplyError(reply, msg.Id, &e)
		return
	}
	account, ok := params[0].(string)
	if !ok {
		e.Message = "account is not a string"
		ReplyError(reply, msg.Id, &e)
		return
	}

	var result interface{}
	wallets.RLock()
	w := wallets.m[account]
	wallets.RUnlock()

	if w != nil {
		result = w.Wallet.GetActiveAddresses()
	} else {
		ReplyError(reply, msg.Id, &WalletInvalidAccountName)
		return
	}

	ReplySuccess(reply, msg.Id, result)
}

// GetBalance replies with the balance for an account (wallet).  If
// the requested wallet does not exist, a JSON error will be returned to
// the client.
func GetBalance(reply chan []byte, msg *btcjson.Message) {
	params, ok := msg.Params.([]interface{})
	if !ok {
		log.Error("GetBalance: Cannot parse parameters.")
		return
	}
	var wname string
	conf := 1
	if len(params) > 0 {
		if s, ok := params[0].(string); ok {
			wname = s
		} else {
			ReplyError(reply, msg.Id, &InvalidParams)
		}
	}
	if len(params) > 1 {
		if f, ok := params[1].(float64); ok {
			conf = int(f)
		} else {
			ReplyError(reply, msg.Id, &InvalidParams)
		}
	}

	wallets.RLock()
	w := wallets.m[wname]
	wallets.RUnlock()
	var result interface{}
	if w != nil {
		result = w.CalculateBalance(conf)
		ReplySuccess(reply, msg.Id, result)
	} else {
		e := WalletInvalidAccountName
		e.Message = fmt.Sprintf("Wallet for account '%s' does not exist.", wname)
		ReplyError(reply, msg.Id, &e)
	}
}

// GetNewAddress gets or generates a new address for an account.  If
// the requested wallet does not exist, a JSON error will be returned to
// the client.
func GetNewAddress(reply chan []byte, msg *btcjson.Message) {
	e := InvalidParams
	params, ok := msg.Params.([]interface{})
	if !ok {
		ReplyError(reply, msg.Id, &e)
		return
	}
	var wname string
	if len(params) > 0 {
		var ok bool
		if wname, ok = params[0].(string); !ok {
			e.Message = "account is not a string"
			ReplyError(reply, msg.Id, &e)
			return
		}
	}

	wallets.RLock()
	w := wallets.m[wname]
	wallets.RUnlock()
	if w != nil {
		// TODO(jrick): generate new addresses if the address pool is empty.
		addr, err := w.NextUnusedAddress()
		if err != nil {
			e := InternalError
			e.Message = fmt.Sprintf("New address generation not implemented yet")
			ReplyError(reply, msg.Id, &e)
			return
		}
		w.ReqNewTxsForAddress(addr)
		ReplySuccess(reply, msg.Id, addr)
	} else {
		e := WalletInvalidAccountName
		e.Message = fmt.Sprintf("Wallet for account '%s' does not exist.", wname)
		ReplyError(reply, msg.Id, &e)
	}
}

// SendFrom creates a new transaction spending unspent transaction
// outputs for a wallet to another payment address.  Leftover inputs
// not sent to the payment address or a fee for the miner are sent
// back to a new address in the wallet.
func SendFrom(reply chan []byte, msg *btcjson.Message) {
	e := InvalidParams
	params, ok := msg.Params.([]interface{})
	if !ok {
		e.Message = "Cannot parse parameters."
		ReplyError(reply, msg.Id, &e)
		return
	}
	var fromaccount, toaddr58, comment, commentto string
	var famt, minconf float64
	if len(params) < 3 {
		e.Message = "Too few parameters."
		ReplyError(reply, msg.Id, &e)
		return
	}
	if fromaccount, ok = params[0].(string); !ok {
		e.Message = "fromaccount is not a string"
		ReplyError(reply, msg.Id, &e)
		return
	}
	if toaddr58, ok = params[1].(string); !ok {
		e.Message = "tobitcoinaddress is not a string"
		ReplyError(reply, msg.Id, &e)
		return
	}
	if famt, ok = params[2].(float64); !ok {
		e.Message = "amount is not a number"
		ReplyError(reply, msg.Id, &e)
		return
	}
	if famt < 0 {
		e.Message = "amount cannot be negative"
		ReplyError(reply, msg.Id, &e)
		return
	}
	amt, err := btcjson.JSONToAmount(famt)
	if err != nil {
		e.Message = "amount cannot be converted to integer"
		ReplyError(reply, msg.Id, &e)
		return
	}
	if len(params) > 3 {
		if minconf, ok = params[3].(float64); !ok {
			e.Message = "minconf is not a number"
			ReplyError(reply, msg.Id, &e)
			return
		}
		if minconf < 0 {
			e.Message = "minconf cannot be negative"
			ReplyError(reply, msg.Id, &e)
		}
	}
	if len(params) > 4 {
		if comment, ok = params[4].(string); !ok {
			e.Message = "comment is not a string"
			ReplyError(reply, msg.Id, &e)
			return
		}
	}
	if len(params) > 5 {
		if commentto, ok = params[5].(string); !ok {
			e.Message = "comment-to is not a string"
			ReplyError(reply, msg.Id, &e)
			return
		}
	}

	// Is wallet for this account unlocked?
	wallets.Lock()
	w := wallets.m[fromaccount]
	wallets.Unlock()
	if w.IsLocked() {
		ReplyError(reply, msg.Id, &WalletUnlockNeeded)
		return
	}

	TxFee.Lock()
	fee := TxFee.i
	TxFee.Unlock()
	pairs := map[string]uint64{
		toaddr58: uint64(amt),
	}
	rawtx, err := w.txToPairs(pairs, uint64(fee), int(minconf))
	if err != nil {
		e := InternalError
		e.Message = err.Error()
		ReplyError(reply, msg.Id, &e)
		return
	}

	// Send rawtx off to btcd
	seq.Lock()
	n := seq.n
	seq.n++
	seq.Unlock()

	var id interface{} = fmt.Sprintf("btcwallet(%v)-%v", n, msg.Id)
	m, err := btcjson.CreateMessageWithId("sendrawtransaction", id,
		hex.EncodeToString(rawtx))
	if err != nil {
		e := InternalError
		e.Message = err.Error()
		ReplyError(reply, msg.Id, &e)
		return
	}
	replyRouter.Lock()
	replyRouter.m[n] = reply
	replyRouter.Unlock()
	btcdMsgs <- m

	// TODO(jrick): If message succeeded in being sent, save the
	// transaction details with comments.
	_, _ = comment, commentto
}

// SendMany creates a new transaction spending unspent transaction
// outputs for a wallet to any number of  payment addresses.  Leftover
// inputs not sent to the payment address or a fee for the miner are
// sent back to a new address in the wallet.
func SendMany(reply chan []byte, msg *btcjson.Message) {
	e := InvalidParams
	params, ok := msg.Params.([]interface{})
	if !ok {
		e.Message = "Cannot parse parameters."
		ReplyError(reply, msg.Id, &e)
		return
	}
	var fromaccount, comment string
	var minconf float64
	var jsonPairs map[string]interface{}
	if len(params) < 2 {
		e.Message = "Too few parameters."
		ReplyError(reply, msg.Id, &e)
		return
	}
	if fromaccount, ok = params[0].(string); !ok {
		e.Message = "fromaccount is not a string"
		ReplyError(reply, msg.Id, &e)
		return
	}
	if jsonPairs, ok = params[1].(map[string]interface{}); !ok {
		e.Message = "address and amount pairs is not a JSON object"
		ReplyError(reply, msg.Id, &e)
		return
	}
	pairs := make(map[string]uint64)
	for toaddr58, iamt := range jsonPairs {
		famt, ok := iamt.(float64)
		if !ok {
			e.Message = "amount is not a number"
			ReplyError(reply, msg.Id, &e)
			return
		}
		if famt < 0 {
			e.Message = "amount cannot be negative"
			ReplyError(reply, msg.Id, &e)
			return
		}
		amt, err := btcjson.JSONToAmount(famt)
		if err != nil {
			e.Message = "amount cannot be converted to integer"
			ReplyError(reply, msg.Id, &e)
			return
		}
		pairs[toaddr58] = uint64(amt)
	}

	if len(params) > 2 {
		if minconf, ok = params[2].(float64); !ok {
			e.Message = "minconf is not a number"
			ReplyError(reply, msg.Id, &e)
			return
		}
		if minconf < 0 {
			e.Message = "minconf cannot be negative"
			ReplyError(reply, msg.Id, &e)
			return
		}
	}
	if len(params) > 3 {
		if comment, ok = params[3].(string); !ok {
			e.Message = "comment is not a string"
			ReplyError(reply, msg.Id, &e)
			return
		}
	}

	// Is wallet for this account unlocked?
	wallets.Lock()
	w := wallets.m[fromaccount]
	wallets.Unlock()
	if w.IsLocked() {
		ReplyError(reply, msg.Id, &WalletUnlockNeeded)
		return
	}

	TxFee.Lock()
	fee := TxFee.i
	TxFee.Unlock()
	rawtx, err := w.txToPairs(pairs, uint64(fee), int(minconf))
	if err != nil {
		e := InternalError
		e.Message = err.Error()
		ReplyError(reply, msg.Id, &e)
		return
	}

	// Send rawtx off to btcd
	seq.Lock()
	n := seq.n
	seq.n++
	seq.Unlock()

	var id interface{} = fmt.Sprintf("btcwallet(%v)-%v", n, msg.Id)
	m, err := btcjson.CreateMessageWithId("sendrawtransaction", id,
		hex.EncodeToString(rawtx))
	if err != nil {
		e := InternalError
		e.Message = err.Error()
		ReplyError(reply, msg.Id, &e)
		return
	}
	replyRouter.Lock()
	replyRouter.m[n] = reply
	replyRouter.Unlock()
	btcdMsgs <- m

	// TODO(jrick): If message succeeded in being sent, save the
	// transaction details with comments.
	_ = comment
}

// SetTxFee sets the global transaction fee added to transactions.
func SetTxFee(reply chan []byte, msg *btcjson.Message) {
	e := InvalidParams
	params, ok := msg.Params.([]interface{})
	if !ok {
		ReplyError(reply, msg.Id, &e)
		return
	}
	if len(params) != 1 {
		e.Message = "Incorrect number of parameters"
		ReplyError(reply, msg.Id, &e)
		return
	}
	jsonFee, ok := params[0].(float64)
	if !ok {
		e.Message = "Amount is not a number"
		ReplyError(reply, msg.Id, &e)
		return
	}
	if jsonFee < 0 {
		e.Message = "Amount cannot be negative"
		ReplyError(reply, msg.Id, &e)
		return
	}
	fee, err := btcjson.JSONToAmount(jsonFee)
	if err != nil {
		e.Message = fmt.Sprintf("Cannot convert JSON number to int64: %v", err)
		ReplyError(reply, msg.Id, &e)
		return
	}

	// TODO(jrick): need to notify all frontends of new tx fee.
	TxFee.Lock()
	TxFee.i = fee
	TxFee.Unlock()

	ReplySuccess(reply, msg.Id, true)
}

// CreateEncryptedWallet creates a new encrypted wallet.  The form of the command is:
//
//  createencryptedwallet [account] [description] [passphrase]
//
// All three parameters are required, and must be of type string.  If
// the wallet specified by account already exists, an invalid account
// name error is returned to the client.
//
// Wallets will be created on TestNet3, or MainNet if btcwallet is run with
// the --mainnet option.
func CreateEncryptedWallet(reply chan []byte, msg *btcjson.Message) {
	e := InvalidParams
	params, ok := msg.Params.([]interface{})
	if !ok {
		ReplyError(reply, msg.Id, &e)
		return
	}
	if len(params) != 3 {
		e.Message = "Incorrect number of parameters"
		ReplyError(reply, msg.Id, &e)
		return
	}
	wname, ok := params[0].(string)
	if !ok {
		e.Message = "Account is not a string"
		ReplyError(reply, msg.Id, &e)
		return
	}
	desc, ok := params[1].(string)
	if !ok {
		e.Message = "Description is not a string"
		ReplyError(reply, msg.Id, &e)
		return
	}
	pass, ok := params[2].(string)
	if !ok {
		e.Message = "Passphrase is not a string"
		ReplyError(reply, msg.Id, &e)
		return
	}

	// Does this wallet already exist?
	wallets.Lock()
	if w := wallets.m[wname]; w != nil {
		e := WalletInvalidAccountName
		e.Message = "Wallet already exists."
		ReplyError(reply, msg.Id, &e)
		return
	}
	defer wallets.Unlock()

	var net btcwire.BitcoinNet
	if cfg.MainNet {
		net = btcwire.MainNet
	} else {
		net = btcwire.TestNet3
	}
	w, err := wallet.NewWallet(wname, desc, []byte(pass), net)
	if err != nil {
		log.Error("Error creating wallet: " + err.Error())
		ReplyError(reply, msg.Id, &InternalError)
		return
	}

	// Grab a new unique sequence number for tx notifications in new blocks.
	seq.Lock()
	n := seq.n
	seq.n++
	seq.Unlock()

	bw := &BtcWallet{
		Wallet:         w,
		NewBlockTxSeqN: n,
	}
	// TODO(jrick): only begin tracking wallet if btcwallet is already
	// connected to btcd.
	bw.Track()

	wallets.m[wname] = bw
	ReplySuccess(reply, msg.Id, nil)
}

// WalletIsLocked returns whether the wallet used by the specified
// account, or default account, is locked.
func WalletIsLocked(reply chan []byte, msg *btcjson.Message) {
	params, ok := msg.Params.([]interface{})
	if !ok {
		log.Error("WalletIsLocked: Cannot parse parameters.")
	}
	account := ""
	if len(params) > 0 {
		if acct, ok := params[0].(string); ok {
			account = acct
		} else {
			ReplyError(reply, msg.Id, &InvalidParams)
			return
		}
	}
	wallets.RLock()
	w := wallets.m[account]
	wallets.RUnlock()
	if w != nil {
		result := w.IsLocked()
		ReplySuccess(reply, msg.Id, result)
	} else {
		ReplyError(reply, msg.Id, &WalletInvalidAccountName)
	}
}

// WalletLock locks the wallet.
//
// TODO(jrick): figure out how multiple wallets/accounts will work
// with this.  Lock all the wallets, like if all accounts are locked
// for one bitcoind wallet?
func WalletLock(reply chan []byte, msg *btcjson.Message) {
	wallets.RLock()
	w := wallets.m[""]
	wallets.RUnlock()
	if w != nil {
		if err := w.Lock(); err != nil {
			ReplyError(reply, msg.Id, &WalletWrongEncState)
		} else {
			ReplySuccess(reply, msg.Id, nil)
			NotifyWalletLockStateChange(reply, true)
		}
	}
}

// WalletPassphrase stores the decryption key for the default account,
// unlocking the wallet.
//
// TODO(jrick): figure out how to do this for non-default accounts.
func WalletPassphrase(reply chan []byte, msg *btcjson.Message) {
	params, ok := msg.Params.([]interface{})
	if !ok {
		log.Error("WalletPassphrase: Cannot parse parameters.")
		return
	}
	if len(params) != 2 {
		ReplyError(reply, msg.Id, &InvalidParams)
		return
	}
	passphrase, ok1 := params[0].(string)
	timeout, ok2 := params[1].(float64)
	if !ok1 || !ok2 {
		ReplyError(reply, msg.Id, &InvalidParams)
		return
	}

	wallets.RLock()
	w := wallets.m[""]
	wallets.RUnlock()
	if w != nil {
		if err := w.Unlock([]byte(passphrase)); err != nil {
			ReplyError(reply, msg.Id, &WalletPassphraseIncorrect)
			return
		}
		ReplySuccess(reply, msg.Id, nil)
		NotifyWalletLockStateChange(reply, false)
		go func() {
			time.Sleep(time.Second * time.Duration(int64(timeout)))
			w.Lock()
			NotifyWalletLockStateChange(reply, true)
		}()
	}
}

// BtcdConnected is the wallet handler for the frontend
// 'btcdconnected' method.  It returns to the frontend whether btcwallet
// is currently connected to btcd or not.
func BtcdConnected(reply chan []byte, msg *btcjson.Message) {
	ReplySuccess(reply, msg.Id, btcdConnected.b)
}

// NotifyWalletLockStateChange sends a notification to all frontends
// that the wallet has just been locked or unlocked.
func NotifyWalletLockStateChange(reply chan []byte, locked bool) {
	var id interface{} = "btcwallet:newwalletlockstate"
	m := btcjson.Reply{
		Result: locked,
		Id:     &id,
	}
	msg, _ := json.Marshal(&m)
	frontendNotificationMaster <- msg
}