mirror of
https://github.com/kaspanet/kaspad.git
synced 2026-03-17 13:54:56 +00:00
BIP0144+wire: add a MessageEncoding variant for serialization/deserialization
This commit modifies the existing wire.Message interface to introduce a new MessageEncoding variant which dictates the exact encoding to be used when serializing and deserializing messages. Such an option is now necessary due to the segwit soft-fork package, as btcd will need to be able to optionally encode transactions/blocks without witness data to un-upgraded peers. Two new functions have been introduced: ReadMessageWithEncodingN and WriteMessageWithEncodingN which wrap BtcDecode/BtcEncode with the desired encoding format.
This commit is contained in:
Olaoluwa Osuntokun
committed by
Dave Collins
Dave Collins
parent
1b359e1131
commit
48abfdf87c
@@ -45,6 +45,7 @@ func TestRejectCodeStringer(t *testing.T) {
|
||||
// TestRejectLatest tests the MsgPong API against the latest protocol version.
|
||||
func TestRejectLatest(t *testing.T) {
|
||||
pver := ProtocolVersion
|
||||
enc := BaseEncoding
|
||||
|
||||
// Create reject message data.
|
||||
rejCommand := (&MsgBlock{}).Command()
|
||||
@@ -86,14 +87,14 @@ func TestRejectLatest(t *testing.T) {
|
||||
|
||||
// Test encode with latest protocol version.
|
||||
var buf bytes.Buffer
|
||||
err := msg.BtcEncode(&buf, pver)
|
||||
err := msg.BtcEncode(&buf, pver, enc)
|
||||
if err != nil {
|
||||
t.Errorf("encode of MsgReject failed %v err <%v>", msg, err)
|
||||
}
|
||||
|
||||
// Test decode with latest protocol version.
|
||||
readMsg := MsgReject{}
|
||||
err = readMsg.BtcDecode(&buf, pver)
|
||||
err = readMsg.BtcDecode(&buf, pver, enc)
|
||||
if err != nil {
|
||||
t.Errorf("decode of MsgReject failed %v err <%v>", buf.Bytes(),
|
||||
err)
|
||||
@@ -123,6 +124,7 @@ func TestRejectLatest(t *testing.T) {
|
||||
func TestRejectBeforeAdded(t *testing.T) {
|
||||
// Use the protocol version just prior to RejectVersion.
|
||||
pver := RejectVersion - 1
|
||||
enc := BaseEncoding
|
||||
|
||||
// Create reject message data.
|
||||
rejCommand := (&MsgBlock{}).Command()
|
||||
@@ -142,7 +144,7 @@ func TestRejectBeforeAdded(t *testing.T) {
|
||||
|
||||
// Test encode with old protocol version.
|
||||
var buf bytes.Buffer
|
||||
err := msg.BtcEncode(&buf, pver)
|
||||
err := msg.BtcEncode(&buf, pver, enc)
|
||||
if err == nil {
|
||||
t.Errorf("encode of MsgReject succeeded when it shouldn't "+
|
||||
"have %v", msg)
|
||||
@@ -150,7 +152,7 @@ func TestRejectBeforeAdded(t *testing.T) {
|
||||
|
||||
// // Test decode with old protocol version.
|
||||
readMsg := MsgReject{}
|
||||
err = readMsg.BtcDecode(&buf, pver)
|
||||
err = readMsg.BtcDecode(&buf, pver, enc)
|
||||
if err == nil {
|
||||
t.Errorf("decode of MsgReject succeeded when it shouldn't "+
|
||||
"have %v", spew.Sdump(buf.Bytes()))
|
||||
@@ -191,14 +193,14 @@ func TestRejectCrossProtocol(t *testing.T) {
|
||||
|
||||
// Encode with latest protocol version.
|
||||
var buf bytes.Buffer
|
||||
err := msg.BtcEncode(&buf, ProtocolVersion)
|
||||
err := msg.BtcEncode(&buf, ProtocolVersion, BaseEncoding)
|
||||
if err != nil {
|
||||
t.Errorf("encode of MsgReject failed %v err <%v>", msg, err)
|
||||
}
|
||||
|
||||
// Decode with old protocol version.
|
||||
readMsg := MsgReject{}
|
||||
err = readMsg.BtcDecode(&buf, RejectVersion-1)
|
||||
err = readMsg.BtcDecode(&buf, RejectVersion-1, BaseEncoding)
|
||||
if err == nil {
|
||||
t.Errorf("encode of MsgReject succeeded when it shouldn't "+
|
||||
"have %v", msg)
|
||||
@@ -225,9 +227,10 @@ func TestRejectCrossProtocol(t *testing.T) {
|
||||
// protocol versions.
|
||||
func TestRejectWire(t *testing.T) {
|
||||
tests := []struct {
|
||||
msg MsgReject // Message to encode
|
||||
buf []byte // Wire encoding
|
||||
pver uint32 // Protocol version for wire encoding
|
||||
msg MsgReject // Message to encode
|
||||
buf []byte // Wire encoding
|
||||
pver uint32 // Protocol version for wire encoding
|
||||
enc MessageEncoding // Message encoding format
|
||||
}{
|
||||
// Latest protocol version rejected command version (no hash).
|
||||
{
|
||||
@@ -244,6 +247,7 @@ func TestRejectWire(t *testing.T) {
|
||||
0x6f, 0x6e, // "duplicate version"
|
||||
},
|
||||
ProtocolVersion,
|
||||
BaseEncoding,
|
||||
},
|
||||
// Latest protocol version rejected command block (has hash).
|
||||
{
|
||||
@@ -264,6 +268,7 @@ func TestRejectWire(t *testing.T) {
|
||||
0x68, 0xd6, 0x19, 0x00, 0x00, 0x00, 0x00, 0x00, // mainNetGenesisHash
|
||||
},
|
||||
ProtocolVersion,
|
||||
BaseEncoding,
|
||||
},
|
||||
}
|
||||
|
||||
@@ -271,7 +276,7 @@ func TestRejectWire(t *testing.T) {
|
||||
for i, test := range tests {
|
||||
// Encode the message to wire format.
|
||||
var buf bytes.Buffer
|
||||
err := test.msg.BtcEncode(&buf, test.pver)
|
||||
err := test.msg.BtcEncode(&buf, test.pver, test.enc)
|
||||
if err != nil {
|
||||
t.Errorf("BtcEncode #%d error %v", i, err)
|
||||
continue
|
||||
@@ -285,7 +290,7 @@ func TestRejectWire(t *testing.T) {
|
||||
// Decode the message from wire format.
|
||||
var msg MsgReject
|
||||
rbuf := bytes.NewReader(test.buf)
|
||||
err = msg.BtcDecode(rbuf, test.pver)
|
||||
err = msg.BtcDecode(rbuf, test.pver, test.enc)
|
||||
if err != nil {
|
||||
t.Errorf("BtcDecode #%d error %v", i, err)
|
||||
continue
|
||||
@@ -319,31 +324,32 @@ func TestRejectWireErrors(t *testing.T) {
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
in *MsgReject // Value to encode
|
||||
buf []byte // Wire encoding
|
||||
pver uint32 // Protocol version for wire encoding
|
||||
max int // Max size of fixed buffer to induce errors
|
||||
writeErr error // Expected write error
|
||||
readErr error // Expected read error
|
||||
in *MsgReject // Value to encode
|
||||
buf []byte // Wire encoding
|
||||
pver uint32 // Protocol version for wire encoding
|
||||
enc MessageEncoding // Message encoding format
|
||||
max int // Max size of fixed buffer to induce errors
|
||||
writeErr error // Expected write error
|
||||
readErr error // Expected read error
|
||||
}{
|
||||
// Latest protocol version with intentional read/write errors.
|
||||
// Force error in reject command.
|
||||
{baseReject, baseRejectEncoded, pver, 0, io.ErrShortWrite, io.EOF},
|
||||
{baseReject, baseRejectEncoded, pver, BaseEncoding, 0, io.ErrShortWrite, io.EOF},
|
||||
// Force error in reject code.
|
||||
{baseReject, baseRejectEncoded, pver, 6, io.ErrShortWrite, io.EOF},
|
||||
{baseReject, baseRejectEncoded, pver, BaseEncoding, 6, io.ErrShortWrite, io.EOF},
|
||||
// Force error in reject reason.
|
||||
{baseReject, baseRejectEncoded, pver, 7, io.ErrShortWrite, io.EOF},
|
||||
{baseReject, baseRejectEncoded, pver, BaseEncoding, 7, io.ErrShortWrite, io.EOF},
|
||||
// Force error in reject hash.
|
||||
{baseReject, baseRejectEncoded, pver, 23, io.ErrShortWrite, io.EOF},
|
||||
{baseReject, baseRejectEncoded, pver, BaseEncoding, 23, io.ErrShortWrite, io.EOF},
|
||||
// Force error due to unsupported protocol version.
|
||||
{baseReject, baseRejectEncoded, pverNoReject, 6, wireErr, wireErr},
|
||||
{baseReject, baseRejectEncoded, pverNoReject, BaseEncoding, 6, wireErr, wireErr},
|
||||
}
|
||||
|
||||
t.Logf("Running %d tests", len(tests))
|
||||
for i, test := range tests {
|
||||
// Encode to wire format.
|
||||
w := newFixedWriter(test.max)
|
||||
err := test.in.BtcEncode(w, test.pver)
|
||||
err := test.in.BtcEncode(w, test.pver, test.enc)
|
||||
if reflect.TypeOf(err) != reflect.TypeOf(test.writeErr) {
|
||||
t.Errorf("BtcEncode #%d wrong error got: %v, want: %v",
|
||||
i, err, test.writeErr)
|
||||
@@ -363,7 +369,7 @@ func TestRejectWireErrors(t *testing.T) {
|
||||
// Decode from wire format.
|
||||
var msg MsgReject
|
||||
r := newFixedReader(test.max, test.buf)
|
||||
err = msg.BtcDecode(r, test.pver)
|
||||
err = msg.BtcDecode(r, test.pver, test.enc)
|
||||
if reflect.TypeOf(err) != reflect.TypeOf(test.readErr) {
|
||||
t.Errorf("BtcDecode #%d wrong error got: %v, want: %v",
|
||||
i, err, test.readErr)
|
||||
|
||||
Reference in New Issue
Block a user