mirror of
https://github.com/kaspanet/kaspad.git
synced 2026-03-19 06:39:08 +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:
committed by
Dave Collins
parent
1b359e1131
commit
48abfdf87c
@@ -16,6 +16,7 @@ import (
|
||||
// version.
|
||||
func TestSendHeaders(t *testing.T) {
|
||||
pver := ProtocolVersion
|
||||
enc := BaseEncoding
|
||||
|
||||
// Ensure the command is expected value.
|
||||
wantCmd := "sendheaders"
|
||||
@@ -36,7 +37,7 @@ func TestSendHeaders(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 MsgSendHeaders failed %v err <%v>", msg,
|
||||
err)
|
||||
@@ -45,7 +46,7 @@ func TestSendHeaders(t *testing.T) {
|
||||
// Older protocol versions should fail encode since message didn't
|
||||
// exist yet.
|
||||
oldPver := SendHeadersVersion - 1
|
||||
err = msg.BtcEncode(&buf, oldPver)
|
||||
err = msg.BtcEncode(&buf, oldPver, enc)
|
||||
if err == nil {
|
||||
s := "encode of MsgSendHeaders passed for old protocol " +
|
||||
"version %v err <%v>"
|
||||
@@ -54,7 +55,7 @@ func TestSendHeaders(t *testing.T) {
|
||||
|
||||
// Test decode with latest protocol version.
|
||||
readmsg := NewMsgSendHeaders()
|
||||
err = readmsg.BtcDecode(&buf, pver)
|
||||
err = readmsg.BtcDecode(&buf, pver, enc)
|
||||
if err != nil {
|
||||
t.Errorf("decode of MsgSendHeaders failed [%v] err <%v>", buf,
|
||||
err)
|
||||
@@ -62,7 +63,7 @@ func TestSendHeaders(t *testing.T) {
|
||||
|
||||
// Older protocol versions should fail decode since message didn't
|
||||
// exist yet.
|
||||
err = readmsg.BtcDecode(&buf, oldPver)
|
||||
err = readmsg.BtcDecode(&buf, oldPver, enc)
|
||||
if err == nil {
|
||||
s := "decode of MsgSendHeaders passed for old protocol " +
|
||||
"version %v err <%v>"
|
||||
@@ -75,12 +76,13 @@ func TestSendHeaders(t *testing.T) {
|
||||
func TestSendHeadersBIP0130(t *testing.T) {
|
||||
// Use the protocol version just prior to SendHeadersVersion changes.
|
||||
pver := SendHeadersVersion - 1
|
||||
enc := BaseEncoding
|
||||
|
||||
msg := NewMsgSendHeaders()
|
||||
|
||||
// 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 MsgSendHeaders succeeded when it should " +
|
||||
"have failed")
|
||||
@@ -88,7 +90,7 @@ func TestSendHeadersBIP0130(t *testing.T) {
|
||||
|
||||
// Test decode with old protocol version.
|
||||
readmsg := NewMsgSendHeaders()
|
||||
err = readmsg.BtcDecode(&buf, pver)
|
||||
err = readmsg.BtcDecode(&buf, pver, enc)
|
||||
if err == nil {
|
||||
t.Errorf("decode of MsgSendHeaders succeeded when it should " +
|
||||
"have failed")
|
||||
@@ -98,11 +100,12 @@ func TestSendHeadersBIP0130(t *testing.T) {
|
||||
// TestSendHeadersCrossProtocol tests the MsgSendHeaders API when encoding with
|
||||
// the latest protocol version and decoding with SendHeadersVersion.
|
||||
func TestSendHeadersCrossProtocol(t *testing.T) {
|
||||
enc := BaseEncoding
|
||||
msg := NewMsgSendHeaders()
|
||||
|
||||
// Encode with latest protocol version.
|
||||
var buf bytes.Buffer
|
||||
err := msg.BtcEncode(&buf, ProtocolVersion)
|
||||
err := msg.BtcEncode(&buf, ProtocolVersion, enc)
|
||||
if err != nil {
|
||||
t.Errorf("encode of MsgSendHeaders failed %v err <%v>", msg,
|
||||
err)
|
||||
@@ -110,7 +113,7 @@ func TestSendHeadersCrossProtocol(t *testing.T) {
|
||||
|
||||
// Decode with old protocol version.
|
||||
readmsg := NewMsgSendHeaders()
|
||||
err = readmsg.BtcDecode(&buf, SendHeadersVersion)
|
||||
err = readmsg.BtcDecode(&buf, SendHeadersVersion, enc)
|
||||
if err != nil {
|
||||
t.Errorf("decode of MsgSendHeaders failed [%v] err <%v>", buf,
|
||||
err)
|
||||
@@ -128,6 +131,7 @@ func TestSendHeadersWire(t *testing.T) {
|
||||
out *MsgSendHeaders // Expected decoded message
|
||||
buf []byte // Wire encoding
|
||||
pver uint32 // Protocol version for wire encoding
|
||||
enc MessageEncoding // Message encoding format
|
||||
}{
|
||||
// Latest protocol version.
|
||||
{
|
||||
@@ -135,6 +139,7 @@ func TestSendHeadersWire(t *testing.T) {
|
||||
msgSendHeaders,
|
||||
msgSendHeadersEncoded,
|
||||
ProtocolVersion,
|
||||
BaseEncoding,
|
||||
},
|
||||
|
||||
// Protocol version SendHeadersVersion+1
|
||||
@@ -143,6 +148,7 @@ func TestSendHeadersWire(t *testing.T) {
|
||||
msgSendHeaders,
|
||||
msgSendHeadersEncoded,
|
||||
SendHeadersVersion + 1,
|
||||
BaseEncoding,
|
||||
},
|
||||
|
||||
// Protocol version SendHeadersVersion
|
||||
@@ -151,6 +157,7 @@ func TestSendHeadersWire(t *testing.T) {
|
||||
msgSendHeaders,
|
||||
msgSendHeadersEncoded,
|
||||
SendHeadersVersion,
|
||||
BaseEncoding,
|
||||
},
|
||||
}
|
||||
|
||||
@@ -158,7 +165,7 @@ func TestSendHeadersWire(t *testing.T) {
|
||||
for i, test := range tests {
|
||||
// Encode the message to wire format.
|
||||
var buf bytes.Buffer
|
||||
err := test.in.BtcEncode(&buf, test.pver)
|
||||
err := test.in.BtcEncode(&buf, test.pver, test.enc)
|
||||
if err != nil {
|
||||
t.Errorf("BtcEncode #%d error %v", i, err)
|
||||
continue
|
||||
@@ -172,7 +179,7 @@ func TestSendHeadersWire(t *testing.T) {
|
||||
// Decode the message from wire format.
|
||||
var msg MsgSendHeaders
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user