mirror of
https://github.com/FlipsideCrypto/dcrd.git
synced 2026-02-06 10:56:47 +00:00
b6d426241d
This commit is the first stage of several that are planned to convert
the blockchain package into a concurrent safe package that will
ultimately allow support for multi-peer download and concurrent chain
processing. The goal is to update btcd proper after each step so it can
take advantage of the enhancements as they are developed.
In addition to the aforementioned benefit, this staged approach has been
chosen since it is absolutely critical to maintain consensus.
Separating the changes into several stages makes it easier for reviewers
to logically follow what is happening and therefore helps prevent
consensus bugs. Naturally there are significant automated tests to help
prevent consensus issues as well.
The main focus of this stage is to convert the blockchain package to use
the new database interface and implement the chain-related functionality
which it no longer handles. It also aims to improve efficiency in
various areas by making use of the new database and chain capabilities.
The following is an overview of the chain changes:
- Update to use the new database interface
- Add chain-related functionality that the old database used to handle
- Main chain structure and state
- Transaction spend tracking
- Implement a new pruned unspent transaction output (utxo) set
- Provides efficient direct access to the unspent transaction outputs
- Uses a domain specific compression algorithm that understands the
standard transaction scripts in order to significantly compress them
- Removes reliance on the transaction index and paves the way toward
eventually enabling block pruning
- Modify the New function to accept a Config struct instead of
inidividual parameters
- Replace the old TxStore type with a new UtxoViewpoint type that makes
use of the new pruned utxo set
- Convert code to treat the new UtxoViewpoint as a rolling view that is
used between connects and disconnects to improve efficiency
- Make best chain state always set when the chain instance is created
- Remove now unnecessary logic for dealing with unset best state
- Make all exported functions concurrent safe
- Currently using a single chain state lock as it provides a straight
forward and easy to review path forward however this can be improved
with more fine grained locking
- Optimize various cases where full blocks were being loaded when only
the header is needed to help reduce the I/O load
- Add the ability for callers to get a snapshot of the current best
chain stats in a concurrent safe fashion
- Does not block callers while new blocks are being processed
- Make error messages that reference transaction outputs consistently
use <transaction hash>:<output index>
- Introduce a new AssertError type an convert internal consistency
checks to use it
- Update tests and examples to reflect the changes
- Add a full suite of tests to ensure correct functionality of the new
code
The following is an overview of the btcd changes:
- Update to use the new database and chain interfaces
- Temporarily remove all code related to the transaction index
- Temporarily remove all code related to the address index
- Convert all code that uses transaction stores to use the new utxo
view
- Rework several calls that required the block manager for safe
concurrency to use the chain package directly now that it is
concurrent safe
- Change all calls to obtain the best hash to use the new best state
snapshot capability from the chain package
- Remove workaround for limits on fetching height ranges since the new
database interface no longer imposes them
- Correct the gettxout RPC handler to return the best chain hash as
opposed the hash the txout was found in
- Optimize various RPC handlers:
- Change several of the RPC handlers to use the new chain snapshot
capability to avoid needlessly loading data
- Update several handlers to use new functionality to avoid accessing
the block manager so they are able to return the data without
blocking when the server is busy processing blocks
- Update non-verbose getblock to avoid deserialization and
serialization overhead
- Update getblockheader to request the block height directly from
chain and only load the header
- Update getdifficulty to use the new cached data from chain
- Update getmininginfo to use the new cached data from chain
- Update non-verbose getrawtransaction to avoid deserialization and
serialization overhead
- Update gettxout to use the new utxo store versus loading
full transactions using the transaction index
The following is an overview of the utility changes:
- Update addblock to use the new database and chain interfaces
- Update findcheckpoint to use the new database and chain interfaces
- Remove the dropafter utility which is no longer supported
NOTE: The transaction index and address index will be reimplemented in
another commit.
521 lines
12 KiB
Go
521 lines
12 KiB
Go
// Copyright (c) 2014 The btcsuite developers
|
|
// Copyright (c) 2015-2016 The Decred developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package dcrjson_test
|
|
|
|
import (
|
|
"encoding/json"
|
|
"math"
|
|
"reflect"
|
|
"testing"
|
|
|
|
"github.com/decred/dcrd/dcrjson"
|
|
)
|
|
|
|
// TestAssignField tests the assignField function handles supported combinations
|
|
// properly.
|
|
func TestAssignField(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
dest interface{}
|
|
src interface{}
|
|
expected interface{}
|
|
}{
|
|
{
|
|
name: "same types",
|
|
dest: int8(0),
|
|
src: int8(100),
|
|
expected: int8(100),
|
|
},
|
|
{
|
|
name: "same types - more source pointers",
|
|
dest: int8(0),
|
|
src: func() interface{} {
|
|
i := int8(100)
|
|
return &i
|
|
}(),
|
|
expected: int8(100),
|
|
},
|
|
{
|
|
name: "same types - more dest pointers",
|
|
dest: func() interface{} {
|
|
i := int8(0)
|
|
return &i
|
|
}(),
|
|
src: int8(100),
|
|
expected: int8(100),
|
|
},
|
|
{
|
|
name: "convertible types - more source pointers",
|
|
dest: int16(0),
|
|
src: func() interface{} {
|
|
i := int8(100)
|
|
return &i
|
|
}(),
|
|
expected: int16(100),
|
|
},
|
|
{
|
|
name: "convertible types - both pointers",
|
|
dest: func() interface{} {
|
|
i := int8(0)
|
|
return &i
|
|
}(),
|
|
src: func() interface{} {
|
|
i := int16(100)
|
|
return &i
|
|
}(),
|
|
expected: int8(100),
|
|
},
|
|
{
|
|
name: "convertible types - int16 -> int8",
|
|
dest: int8(0),
|
|
src: int16(100),
|
|
expected: int8(100),
|
|
},
|
|
{
|
|
name: "convertible types - int16 -> uint8",
|
|
dest: uint8(0),
|
|
src: int16(100),
|
|
expected: uint8(100),
|
|
},
|
|
{
|
|
name: "convertible types - uint16 -> int8",
|
|
dest: int8(0),
|
|
src: uint16(100),
|
|
expected: int8(100),
|
|
},
|
|
{
|
|
name: "convertible types - uint16 -> uint8",
|
|
dest: uint8(0),
|
|
src: uint16(100),
|
|
expected: uint8(100),
|
|
},
|
|
{
|
|
name: "convertible types - float32 -> float64",
|
|
dest: float64(0),
|
|
src: float32(1.5),
|
|
expected: float64(1.5),
|
|
},
|
|
{
|
|
name: "convertible types - float64 -> float32",
|
|
dest: float32(0),
|
|
src: float64(1.5),
|
|
expected: float32(1.5),
|
|
},
|
|
{
|
|
name: "convertible types - string -> bool",
|
|
dest: false,
|
|
src: "true",
|
|
expected: true,
|
|
},
|
|
{
|
|
name: "convertible types - string -> int8",
|
|
dest: int8(0),
|
|
src: "100",
|
|
expected: int8(100),
|
|
},
|
|
{
|
|
name: "convertible types - string -> uint8",
|
|
dest: uint8(0),
|
|
src: "100",
|
|
expected: uint8(100),
|
|
},
|
|
{
|
|
name: "convertible types - string -> float32",
|
|
dest: float32(0),
|
|
src: "1.5",
|
|
expected: float32(1.5),
|
|
},
|
|
{
|
|
name: "convertible types - typecase string -> string",
|
|
dest: "",
|
|
src: func() interface{} {
|
|
type foo string
|
|
return foo("foo")
|
|
}(),
|
|
expected: "foo",
|
|
},
|
|
{
|
|
name: "convertible types - string -> array",
|
|
dest: [2]string{},
|
|
src: `["test","test2"]`,
|
|
expected: [2]string{"test", "test2"},
|
|
},
|
|
{
|
|
name: "convertible types - string -> slice",
|
|
dest: []string{},
|
|
src: `["test","test2"]`,
|
|
expected: []string{"test", "test2"},
|
|
},
|
|
{
|
|
name: "convertible types - string -> struct",
|
|
dest: struct{ A int }{},
|
|
src: `{"A":100}`,
|
|
expected: struct{ A int }{100},
|
|
},
|
|
{
|
|
name: "convertible types - string -> map",
|
|
dest: map[string]float64{},
|
|
src: `{"1Address":1.5}`,
|
|
expected: map[string]float64{"1Address": 1.5},
|
|
},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
dst := reflect.New(reflect.TypeOf(test.dest)).Elem()
|
|
src := reflect.ValueOf(test.src)
|
|
err := dcrjson.TstAssignField(1, "testField", dst, src)
|
|
if err != nil {
|
|
t.Errorf("Test #%d (%s) unexpected error: %v", i,
|
|
test.name, err)
|
|
continue
|
|
}
|
|
|
|
// Inidirect through to the base types to ensure their values
|
|
// are the same.
|
|
for dst.Kind() == reflect.Ptr {
|
|
dst = dst.Elem()
|
|
}
|
|
if !reflect.DeepEqual(dst.Interface(), test.expected) {
|
|
t.Errorf("Test #%d (%s) unexpected value - got %v, "+
|
|
"want %v", i, test.name, dst.Interface(),
|
|
test.expected)
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestAssignFieldErrors tests the assignField function error paths.
|
|
func TestAssignFieldErrors(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
dest interface{}
|
|
src interface{}
|
|
err dcrjson.Error
|
|
}{
|
|
{
|
|
name: "general incompatible int -> string",
|
|
dest: string(0),
|
|
src: int(0),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow source int -> dest int",
|
|
dest: int8(0),
|
|
src: int(128),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow source int -> dest uint",
|
|
dest: uint8(0),
|
|
src: int(256),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "int -> float",
|
|
dest: float32(0),
|
|
src: int(256),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow source uint64 -> dest int64",
|
|
dest: int64(0),
|
|
src: uint64(1 << 63),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow source uint -> dest int",
|
|
dest: int8(0),
|
|
src: uint(128),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow source uint -> dest uint",
|
|
dest: uint8(0),
|
|
src: uint(256),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "uint -> float",
|
|
dest: float32(0),
|
|
src: uint(256),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "float -> int",
|
|
dest: int(0),
|
|
src: float32(1.0),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow float64 -> float32",
|
|
dest: float32(0),
|
|
src: float64(math.MaxFloat64),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid string -> bool",
|
|
dest: true,
|
|
src: "foo",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid string -> int",
|
|
dest: int8(0),
|
|
src: "foo",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow string -> int",
|
|
dest: int8(0),
|
|
src: "128",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid string -> uint",
|
|
dest: uint8(0),
|
|
src: "foo",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow string -> uint",
|
|
dest: uint8(0),
|
|
src: "256",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid string -> float",
|
|
dest: float32(0),
|
|
src: "foo",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "overflow string -> float",
|
|
dest: float32(0),
|
|
src: "1.7976931348623157e+308",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid string -> array",
|
|
dest: [3]int{},
|
|
src: "foo",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid string -> slice",
|
|
dest: []int{},
|
|
src: "foo",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid string -> struct",
|
|
dest: struct{ A int }{},
|
|
src: "foo",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid string -> map",
|
|
dest: map[string]int{},
|
|
src: "foo",
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
dst := reflect.New(reflect.TypeOf(test.dest)).Elem()
|
|
src := reflect.ValueOf(test.src)
|
|
err := dcrjson.TstAssignField(1, "testField", dst, src)
|
|
if reflect.TypeOf(err) != reflect.TypeOf(test.err) {
|
|
t.Errorf("Test #%d (%s) wrong error - got %T (%[3]v), "+
|
|
"want %T", i, test.name, err, test.err)
|
|
continue
|
|
}
|
|
gotErrorCode := err.(dcrjson.Error).Code
|
|
if gotErrorCode != test.err.Code {
|
|
t.Errorf("Test #%d (%s) mismatched error code - got "+
|
|
"%v (%v), want %v", i, test.name, gotErrorCode,
|
|
err, test.err.Code)
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestNewCmdErrors ensures the error paths of NewCmd behave as expected.
|
|
func TestNewCmdErrors(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
method string
|
|
args []interface{}
|
|
err dcrjson.Error
|
|
}{
|
|
{
|
|
name: "unregistered command",
|
|
method: "boguscommand",
|
|
args: []interface{}{},
|
|
err: dcrjson.Error{Code: dcrjson.ErrUnregisteredMethod},
|
|
},
|
|
{
|
|
name: "too few parameters to command with required + optional",
|
|
method: "getblock",
|
|
args: []interface{}{},
|
|
err: dcrjson.Error{Code: dcrjson.ErrNumParams},
|
|
},
|
|
{
|
|
name: "too many parameters to command with no optional",
|
|
method: "getblockcount",
|
|
args: []interface{}{"123"},
|
|
err: dcrjson.Error{Code: dcrjson.ErrNumParams},
|
|
},
|
|
{
|
|
name: "incorrect parameter type",
|
|
method: "getblock",
|
|
args: []interface{}{1},
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
_, err := dcrjson.NewCmd(test.method, test.args...)
|
|
if reflect.TypeOf(err) != reflect.TypeOf(test.err) {
|
|
t.Errorf("Test #%d (%s) wrong error - got %T (%[2]v), "+
|
|
"want %T", i, test.name, err, test.err)
|
|
continue
|
|
}
|
|
gotErrorCode := err.(dcrjson.Error).Code
|
|
if gotErrorCode != test.err.Code {
|
|
t.Errorf("Test #%d (%s) mismatched error code - got "+
|
|
"%v (%v), want %v", i, test.name, gotErrorCode,
|
|
err, test.err.Code)
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestMarshalCmdErrors tests the error paths of the MarshalCmd function.
|
|
func TestMarshalCmdErrors(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
id interface{}
|
|
cmd interface{}
|
|
err dcrjson.Error
|
|
}{
|
|
{
|
|
name: "unregistered type",
|
|
id: 1,
|
|
cmd: (*int)(nil),
|
|
err: dcrjson.Error{Code: dcrjson.ErrUnregisteredMethod},
|
|
},
|
|
{
|
|
name: "nil instance of registered type",
|
|
id: 1,
|
|
cmd: (*dcrjson.GetBlockCmd)(nil),
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "nil instance of registered type",
|
|
id: []int{0, 1},
|
|
cmd: &dcrjson.GetBlockCountCmd{},
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
_, err := dcrjson.MarshalCmd(test.id, test.cmd)
|
|
if reflect.TypeOf(err) != reflect.TypeOf(test.err) {
|
|
t.Errorf("Test #%d (%s) wrong error - got %T (%[2]v), "+
|
|
"want %T", i, test.name, err, test.err)
|
|
continue
|
|
}
|
|
gotErrorCode := err.(dcrjson.Error).Code
|
|
if gotErrorCode != test.err.Code {
|
|
t.Errorf("Test #%d (%s) mismatched error code - got "+
|
|
"%v (%v), want %v", i, test.name, gotErrorCode,
|
|
err, test.err.Code)
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestUnmarshalCmdErrors tests the error paths of the UnmarshalCmd function.
|
|
func TestUnmarshalCmdErrors(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
request dcrjson.Request
|
|
err dcrjson.Error
|
|
}{
|
|
{
|
|
name: "unregistered type",
|
|
request: dcrjson.Request{
|
|
Jsonrpc: "1.0",
|
|
Method: "bogusmethod",
|
|
Params: nil,
|
|
ID: nil,
|
|
},
|
|
err: dcrjson.Error{Code: dcrjson.ErrUnregisteredMethod},
|
|
},
|
|
{
|
|
name: "incorrect number of params",
|
|
request: dcrjson.Request{
|
|
Jsonrpc: "1.0",
|
|
Method: "getblockcount",
|
|
Params: []json.RawMessage{[]byte(`"bogusparam"`)},
|
|
ID: nil,
|
|
},
|
|
err: dcrjson.Error{Code: dcrjson.ErrNumParams},
|
|
},
|
|
{
|
|
name: "invalid type for a parameter",
|
|
request: dcrjson.Request{
|
|
Jsonrpc: "1.0",
|
|
Method: "getblock",
|
|
Params: []json.RawMessage{[]byte("1")},
|
|
ID: nil,
|
|
},
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
{
|
|
name: "invalid JSON for a parameter",
|
|
request: dcrjson.Request{
|
|
Jsonrpc: "1.0",
|
|
Method: "getblock",
|
|
Params: []json.RawMessage{[]byte(`"1`)},
|
|
ID: nil,
|
|
},
|
|
err: dcrjson.Error{Code: dcrjson.ErrInvalidType},
|
|
},
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for i, test := range tests {
|
|
_, err := dcrjson.UnmarshalCmd(&test.request)
|
|
if reflect.TypeOf(err) != reflect.TypeOf(test.err) {
|
|
t.Errorf("Test #%d (%s) wrong error - got %T (%[2]v), "+
|
|
"want %T", i, test.name, err, test.err)
|
|
continue
|
|
}
|
|
gotErrorCode := err.(dcrjson.Error).Code
|
|
if gotErrorCode != test.err.Code {
|
|
t.Errorf("Test #%d (%s) mismatched error code - got "+
|
|
"%v (%v), want %v", i, test.name, gotErrorCode,
|
|
err, test.err.Code)
|
|
continue
|
|
}
|
|
}
|
|
}
|