4b99cc99e8
This implements new getcfilterv2 and cfilterv2 messages which are used to request and deliver version 2 committed gcs filters along with their associated header commitment inclusion proof. The getcfilterv2 message requests a version 2 gcs filter and proof for a given block hash. The cfilterv2 message is sent in response with the requested filter and proof. It should be noted that since all header commitments require consensus changes, the proof can only be used once a consensus vote passes and the header actually commits to the filter. Finally, it also bumps the minor default user agent version for the wire package to account for the updates.
148 lines
3.8 KiB
Go
148 lines
3.8 KiB
Go
// Copyright (c) 2013-2016 The btcsuite developers
|
|
// Copyright (c) 2015-2018 The Decred developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package wire
|
|
|
|
import (
|
|
"fmt"
|
|
"strconv"
|
|
"strings"
|
|
)
|
|
|
|
const (
|
|
// InitialProcotolVersion is the initial protocol version for the
|
|
// network.
|
|
InitialProcotolVersion uint32 = 1
|
|
|
|
// ProtocolVersion is the latest protocol version this package supports.
|
|
ProtocolVersion uint32 = 7
|
|
|
|
// NodeBloomVersion is the protocol version which added the SFNodeBloom
|
|
// service flag (unused).
|
|
NodeBloomVersion uint32 = 2
|
|
|
|
// SendHeadersVersion is the protocol version which added a new
|
|
// sendheaders message.
|
|
SendHeadersVersion uint32 = 3
|
|
|
|
// MaxBlockSizeVersion is the protocol version which increased the
|
|
// original blocksize.
|
|
MaxBlockSizeVersion uint32 = 4
|
|
|
|
// FeeFilterVersion is the protocol version which added a new
|
|
// feefilter message.
|
|
FeeFilterVersion uint32 = 5
|
|
|
|
// NodeCFVersion is the protocol version which adds the SFNodeCF service
|
|
// flag and the cfheaders, cfilter, cftypes, getcfheaders, getcfilter and
|
|
// getcftypes messages.
|
|
NodeCFVersion uint32 = 6
|
|
|
|
// CFilterV2Version is the protocol version which adds the getcfilterv2 and
|
|
// cfiltverv2 messages.
|
|
CFilterV2Version uint32 = 7
|
|
)
|
|
|
|
// ServiceFlag identifies services supported by a Decred peer.
|
|
type ServiceFlag uint64
|
|
|
|
const (
|
|
// SFNodeNetwork is a flag used to indicate a peer is a full node.
|
|
SFNodeNetwork ServiceFlag = 1 << iota
|
|
|
|
// SFNodeBloom is a flag used to indicate a peer supports bloom
|
|
// filtering.
|
|
SFNodeBloom
|
|
|
|
// SFNodeCF is a flag used to indicate a peer supports v1 gcs filters
|
|
// (CFs).
|
|
SFNodeCF
|
|
)
|
|
|
|
// Map of service flags back to their constant names for pretty printing.
|
|
var sfStrings = map[ServiceFlag]string{
|
|
SFNodeNetwork: "SFNodeNetwork",
|
|
SFNodeBloom: "SFNodeBloom",
|
|
SFNodeCF: "SFNodeCF",
|
|
}
|
|
|
|
// orderedSFStrings is an ordered list of service flags from highest to
|
|
// lowest.
|
|
var orderedSFStrings = []ServiceFlag{
|
|
SFNodeNetwork,
|
|
SFNodeBloom,
|
|
SFNodeCF,
|
|
}
|
|
|
|
// String returns the ServiceFlag in human-readable form.
|
|
func (f ServiceFlag) String() string {
|
|
// No flags are set.
|
|
if f == 0 {
|
|
return "0x0"
|
|
}
|
|
|
|
// Add individual bit flags.
|
|
s := ""
|
|
for _, flag := range orderedSFStrings {
|
|
if f&flag == flag {
|
|
s += sfStrings[flag] + "|"
|
|
f -= flag
|
|
}
|
|
}
|
|
|
|
// Add any remaining flags which aren't accounted for as hex.
|
|
s = strings.TrimRight(s, "|")
|
|
if f != 0 {
|
|
s += "|0x" + strconv.FormatUint(uint64(f), 16)
|
|
}
|
|
s = strings.TrimLeft(s, "|")
|
|
return s
|
|
}
|
|
|
|
// CurrencyNet represents which Decred network a message belongs to.
|
|
type CurrencyNet uint32
|
|
|
|
// Constants used to indicate the message Decred network. They can also be
|
|
// used to seek to the next message when a stream's state is unknown, but
|
|
// this package does not provide that functionality since it's generally a
|
|
// better idea to simply disconnect clients that are misbehaving over TCP.
|
|
const (
|
|
// MainNet represents the main Decred network.
|
|
MainNet CurrencyNet = 0xd9b400f9
|
|
|
|
// RegNet represents the regression test network.
|
|
RegNet CurrencyNet = 0xdab500fa
|
|
|
|
// RegTest represents the regression test network.
|
|
//
|
|
// DEPRECATED. This will be removed in the next major version bump.
|
|
// Use Regnet instead.
|
|
RegTest CurrencyNet = RegNet
|
|
|
|
// TestNet3 represents the 3rd test network.
|
|
TestNet3 CurrencyNet = 0xb194aa75
|
|
|
|
// SimNet represents the simulation test network.
|
|
SimNet CurrencyNet = 0x12141c16
|
|
)
|
|
|
|
// bnStrings is a map of Decred networks back to their constant names for
|
|
// pretty printing.
|
|
var bnStrings = map[CurrencyNet]string{
|
|
MainNet: "MainNet",
|
|
TestNet3: "TestNet3",
|
|
RegNet: "RegNet",
|
|
SimNet: "SimNet",
|
|
}
|
|
|
|
// String returns the CurrencyNet in human-readable form.
|
|
func (n CurrencyNet) String() string {
|
|
if s, ok := bnStrings[n]; ok {
|
|
return s
|
|
}
|
|
|
|
return fmt.Sprintf("Unknown CurrencyNet (%d)", uint32(n))
|
|
}
|