The following changes were made to ListTransactionsResult (which models the long result format used by listtransactions, listsinceblock, etc.): - Fee made optional (float64 -> *float64 + omitempty) - BlockIndex made optional (int64 + omitempty -> *int64 + omitempty) - InvolvesWatchOnly added (bool + omitempty) - Vout added (uint32) The following changes were made to GetTransactionDetailsResult (which models the short result format of listtransactions): - InvolvesWatchOnly added (bool + omitempty) - Fee added (*float64 + omitempty) - Vout added (uint32) The combination of pointer types and the omitempty struct tag allow excluding the field from the JSON object, or including it with the zero value. This is useful in particular for the fee fields, which should be included whenever the category is "send" even if the fee is zero. Other optional fields which are only added to the result object with non-zero values (such as includeswatchonly) can be reduced to simply an omitempty tag without the pointer type.
182 lines
5.5 KiB
Go
182 lines
5.5 KiB
Go
// Copyright (c) 2014 The btcsuite developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package btcjson_test
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"fmt"
|
|
"reflect"
|
|
"testing"
|
|
|
|
"github.com/btcsuite/btcd/btcjson"
|
|
)
|
|
|
|
// TestWalletSvrWsNtfns tests all of the chain server websocket-specific
|
|
// notifications marshal and unmarshal into valid results include handling of
|
|
// optional fields being omitted in the marshalled command, while optional
|
|
// fields with defaults have the default assigned on unmarshalled commands.
|
|
func TestWalletSvrWsNtfns(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
newNtfn func() (interface{}, error)
|
|
staticNtfn func() interface{}
|
|
marshalled string
|
|
unmarshalled interface{}
|
|
}{
|
|
{
|
|
name: "accountbalance",
|
|
newNtfn: func() (interface{}, error) {
|
|
return btcjson.NewCmd("accountbalance", "acct", 1.25, true)
|
|
},
|
|
staticNtfn: func() interface{} {
|
|
return btcjson.NewAccountBalanceNtfn("acct", 1.25, true)
|
|
},
|
|
marshalled: `{"jsonrpc":"1.0","method":"accountbalance","params":["acct",1.25,true],"id":null}`,
|
|
unmarshalled: &btcjson.AccountBalanceNtfn{
|
|
Account: "acct",
|
|
Balance: 1.25,
|
|
Confirmed: true,
|
|
},
|
|
},
|
|
{
|
|
name: "btcdconnected",
|
|
newNtfn: func() (interface{}, error) {
|
|
return btcjson.NewCmd("btcdconnected", true)
|
|
},
|
|
staticNtfn: func() interface{} {
|
|
return btcjson.NewBtcdConnectedNtfn(true)
|
|
},
|
|
marshalled: `{"jsonrpc":"1.0","method":"btcdconnected","params":[true],"id":null}`,
|
|
unmarshalled: &btcjson.BtcdConnectedNtfn{
|
|
Connected: true,
|
|
},
|
|
},
|
|
{
|
|
name: "walletlockstate",
|
|
newNtfn: func() (interface{}, error) {
|
|
return btcjson.NewCmd("walletlockstate", true)
|
|
},
|
|
staticNtfn: func() interface{} {
|
|
return btcjson.NewWalletLockStateNtfn(true)
|
|
},
|
|
marshalled: `{"jsonrpc":"1.0","method":"walletlockstate","params":[true],"id":null}`,
|
|
unmarshalled: &btcjson.WalletLockStateNtfn{
|
|
Locked: true,
|
|
},
|
|
},
|
|
{
|
|
name: "newtx",
|
|
newNtfn: func() (interface{}, error) {
|
|
return btcjson.NewCmd("newtx", "acct", `{"account":"acct","address":"1Address","category":"send","amount":1.5,"fee":0.0001,"confirmations":1,"txid":"456","walletconflicts":[],"time":12345678,"timereceived":12345876,"vout":789,"otheraccount":"otheracct"}`)
|
|
},
|
|
staticNtfn: func() interface{} {
|
|
result := btcjson.ListTransactionsResult{
|
|
Account: "acct",
|
|
Address: "1Address",
|
|
Category: "send",
|
|
Amount: 1.5,
|
|
Fee: btcjson.Float64(0.0001),
|
|
Confirmations: 1,
|
|
TxID: "456",
|
|
WalletConflicts: []string{},
|
|
Time: 12345678,
|
|
TimeReceived: 12345876,
|
|
Vout: 789,
|
|
OtherAccount: "otheracct",
|
|
}
|
|
return btcjson.NewNewTxNtfn("acct", result)
|
|
},
|
|
marshalled: `{"jsonrpc":"1.0","method":"newtx","params":["acct",{"account":"acct","address":"1Address","amount":1.5,"category":"send","confirmations":1,"fee":0.0001,"time":12345678,"timereceived":12345876,"txid":"456","vout":789,"walletconflicts":[],"otheraccount":"otheracct"}],"id":null}`,
|
|
unmarshalled: &btcjson.NewTxNtfn{
|
|
Account: "acct",
|
|
Details: btcjson.ListTransactionsResult{
|
|
Account: "acct",
|
|
Address: "1Address",
|
|
Category: "send",
|
|
Amount: 1.5,
|
|
Fee: btcjson.Float64(0.0001),
|
|
Confirmations: 1,
|
|
TxID: "456",
|
|
WalletConflicts: []string{},
|
|
Time: 12345678,
|
|
TimeReceived: 12345876,
|
|
Vout: 789,
|
|
OtherAccount: "otheracct",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
// Marshal the notification as created by the new static
|
|
// creation function. The ID is nil for notifications.
|
|
marshalled, err := btcjson.MarshalCmd(nil, test.staticNtfn())
|
|
if err != nil {
|
|
t.Errorf("MarshalCmd #%d (%s) unexpected error: %v", i,
|
|
test.name, err)
|
|
continue
|
|
}
|
|
|
|
if !bytes.Equal(marshalled, []byte(test.marshalled)) {
|
|
t.Errorf("Test #%d (%s) unexpected marshalled data - "+
|
|
"got %s, want %s", i, test.name, marshalled,
|
|
test.marshalled)
|
|
continue
|
|
}
|
|
|
|
// Ensure the notification is created without error via the
|
|
// generic new notification creation function.
|
|
cmd, err := test.newNtfn()
|
|
if err != nil {
|
|
t.Errorf("Test #%d (%s) unexpected NewCmd error: %v ",
|
|
i, test.name, err)
|
|
}
|
|
|
|
// Marshal the notification as created by the generic new
|
|
// notification creation function. The ID is nil for
|
|
// notifications.
|
|
marshalled, err = btcjson.MarshalCmd(nil, cmd)
|
|
if err != nil {
|
|
t.Errorf("MarshalCmd #%d (%s) unexpected error: %v", i,
|
|
test.name, err)
|
|
continue
|
|
}
|
|
|
|
if !bytes.Equal(marshalled, []byte(test.marshalled)) {
|
|
t.Errorf("Test #%d (%s) unexpected marshalled data - "+
|
|
"got %s, want %s", i, test.name, marshalled,
|
|
test.marshalled)
|
|
continue
|
|
}
|
|
|
|
var request btcjson.Request
|
|
if err := json.Unmarshal(marshalled, &request); err != nil {
|
|
t.Errorf("Test #%d (%s) unexpected error while "+
|
|
"unmarshalling JSON-RPC request: %v", i,
|
|
test.name, err)
|
|
continue
|
|
}
|
|
|
|
cmd, err = btcjson.UnmarshalCmd(&request)
|
|
if err != nil {
|
|
t.Errorf("UnmarshalCmd #%d (%s) unexpected error: %v", i,
|
|
test.name, err)
|
|
continue
|
|
}
|
|
|
|
if !reflect.DeepEqual(cmd, test.unmarshalled) {
|
|
t.Errorf("Test #%d (%s) unexpected unmarshalled command "+
|
|
"- got %s, want %s", i, test.name,
|
|
fmt.Sprintf("(%T) %+[1]v", cmd),
|
|
fmt.Sprintf("(%T) %+[1]v\n", test.unmarshalled))
|
|
continue
|
|
}
|
|
}
|
|
}
|