Skip to content

Commit

Permalink
wire-mix: initstate renames
Browse files Browse the repository at this point in the history
  • Loading branch information
@jrick
jrick committed Nov 22, 2023
1 parent 98b56ec commit 96ff57d
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 61 deletions.
4 changes: 2 additions & 2 deletions wire/msggetinitstate.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ const (
// voting.
InitStateTSpends = "tspends"

// InitStateMixPRs is the init state type used to request mixing pair
// InitStateMixPairReqs is the init state type used to request mixing pair
// request messages.
InitStateMixPRs = "mixprs"
InitStateMixPairReqs = "mixpairreqs"
)

// MsgGetInitState implements the Message interface and represents a
Expand Down
78 changes: 39 additions & 39 deletions wire/msginitstate.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ const MaxISVotesAtHeadPerMsg = 40 // 8 * 5
// message.
const MaxISTSpendsAtHeadPerMsg = 7

// MaxISMixPRsPerMsg is the maximum number of pair request mix messages at
// head per message.
const MaxISMixPRsPerMsg = 100
// MaxISMixPairReqsPerMsg is the maximum number of pair request mix messages
// at head per message.
const MaxISMixPairReqsPerMsg = 100

// MsgInitState implements the Message interface and represents an initial
// state message. It is used to receive ephemeral startup information from a
Expand All @@ -34,10 +34,10 @@ const MaxISMixPRsPerMsg = 100
// The content of such a message depends upon what the local peer requested
// during a previous GetInitState msg.
type MsgInitState struct {
BlockHashes []chainhash.Hash
VoteHashes []chainhash.Hash
TSpendHashes []chainhash.Hash
MixPRHashes []chainhash.Hash
BlockHashes []chainhash.Hash
VoteHashes []chainhash.Hash
TSpendHashes []chainhash.Hash
MixPairReqHashes []chainhash.Hash
}

// AddBlockHash adds a new block hash to the message. Up to
Expand Down Expand Up @@ -82,17 +82,17 @@ func (msg *MsgInitState) AddTSpendHash(hash *chainhash.Hash) error {
return nil
}

// AddTSpendHash adds a new mixing pair request message hash to the message.
// AddMixPairReqHash adds a new mixing pair request message hash to the message.
// Up to MaxISMixPRsPerMsg may be added before this function errors out.
func (msg *MsgInitState) AddMixPRHash(hash *chainhash.Hash) error {
const op = "MsgInitState.AddMixPRHash"
if len(msg.MixPRHashes)+1 > MaxISMixPRsPerMsg {
msg := fmt.Sprintf("too many mixpr hashes for message [max %v]",
MaxISMixPRsPerMsg)
func (msg *MsgInitState) AddMixPairReqHash(hash *chainhash.Hash) error {
const op = "MsgInitState.AddMixPairReqHash"
if len(msg.MixPairReqHashes)+1 > MaxISMixPairReqsPerMsg {
msg := fmt.Sprintf("too many mixpairreq hashes for message [max %v]",
MaxISMixPairReqsPerMsg)
return messageError(op, ErrTooManyManyMixPairReqs, msg)
}

msg.MixPRHashes = append(msg.MixPRHashes, *hash)
msg.MixPairReqHashes = append(msg.MixPairReqHashes, *hash)
return nil
}

Expand Down Expand Up @@ -163,7 +163,7 @@ func (msg *MsgInitState) BtcDecode(r io.Reader, pver uint32) error {
}
}

// Read num mixpr hashes (when enabled by protocol).
// Read num mixpairreq hashes (when enabled by protocol).
if pver < MixVersion {
return nil
}
Expand All @@ -172,15 +172,15 @@ func (msg *MsgInitState) BtcDecode(r io.Reader, pver uint32) error {
if err != nil {
return err
}
if count > MaxISMixPRsPerMsg {
msg := fmt.Sprintf("too many mixpr hashes for message "+
"[count %v, max %v]", count, MaxISMixPRsPerMsg)
if count > MaxISMixPairReqsPerMsg {
msg := fmt.Sprintf("too many mixpairreq hashes for message "+
"[count %v, max %v]", count, MaxISMixPairReqsPerMsg)
return messageError(op, ErrTooManyManyMixPairReqs, msg)
}

msg.MixPRHashes = make([]chainhash.Hash, count)
msg.MixPairReqHashes = make([]chainhash.Hash, count)
for i := uint64(0); i < count; i++ {
err := readElement(r, &msg.MixPRHashes[i])
err := readElement(r, &msg.MixPairReqHashes[i])
if err != nil {
return err
}
Expand Down Expand Up @@ -259,15 +259,15 @@ func (msg *MsgInitState) BtcEncode(w io.Writer, pver uint32) error {
}
}

// Write mixpr hashes when enabled by protocol.
// Write mixpairreq hashes when enabled by protocol.
if pver < MixVersion {
return nil
}

count = len(msg.MixPRHashes)
if count > MaxISMixPRsPerMsg {
msg := fmt.Sprintf("too many mixpr hashes for message "+
"[count %v, max %v]", count, MaxISMixPRsPerMsg)
count = len(msg.MixPairReqHashes)
if count > MaxISMixPairReqsPerMsg {
msg := fmt.Sprintf("too many mixpairreq hashes for message "+
"[count %v, max %v]", count, MaxISMixPairReqsPerMsg)
return messageError(op, ErrTooManyManyMixPairReqs, msg)
}

Expand All @@ -276,8 +276,8 @@ func (msg *MsgInitState) BtcEncode(w io.Writer, pver uint32) error {
return err
}

for i := range msg.MixPRHashes {
err = writeElement(w, &msg.MixPRHashes[i])
for i := range msg.MixPairReqHashes {
err = writeElement(w, &msg.MixPairReqHashes[i])
if err != nil {
return err
}
Expand Down Expand Up @@ -307,8 +307,8 @@ func (msg *MsgInitState) MaxPayloadLength(pver uint32) uint32 {
(MaxISTSpendsAtHeadPerMsg * chainhash.HashSize)

if pver >= MixVersion {
max += uint32(VarIntSerializeSize(MaxISMixPRsPerMsg)) +
(MaxISMixPRsPerMsg * chainhash.HashSize)
max += uint32(VarIntSerializeSize(MaxISMixPairReqsPerMsg)) +
(MaxISMixPairReqsPerMsg * chainhash.HashSize)
}

return max
Expand All @@ -318,10 +318,10 @@ func (msg *MsgInitState) MaxPayloadLength(pver uint32) uint32 {
// Message interface using the defaults for the fields.
func NewMsgInitState() *MsgInitState {
return &MsgInitState{
BlockHashes: make([]chainhash.Hash, 0, MaxISBlocksAtHeadPerMsg),
VoteHashes: make([]chainhash.Hash, 0, MaxISVotesAtHeadPerMsg),
TSpendHashes: make([]chainhash.Hash, 0, MaxISTSpendsAtHeadPerMsg),
MixPRHashes: make([]chainhash.Hash, 0, MaxISMixPRsPerMsg),
BlockHashes: make([]chainhash.Hash, 0, MaxISBlocksAtHeadPerMsg),
VoteHashes: make([]chainhash.Hash, 0, MaxISVotesAtHeadPerMsg),
TSpendHashes: make([]chainhash.Hash, 0, MaxISTSpendsAtHeadPerMsg),
MixPairReqHashes: make([]chainhash.Hash, 0, MaxISMixPairReqsPerMsg),
}
}

Expand Down Expand Up @@ -358,15 +358,15 @@ func NewMsgInitStateFilled(blockHashes []chainhash.Hash, voteHashes []chainhash.

// Not preallocated. The purpose of this function is to create a
// MsgInitState from already allocated data. Assume that if the
// caller also has MixPR hashes to include, they have also been
// caller also has mixpairreq hashes to include, they have also been
// preallocated, so there is no reason to allocate the memory here
// too.
var mixPRHashes []chainhash.Hash
var mixPairReqHashes []chainhash.Hash

return &MsgInitState{
BlockHashes: blockHashes,
VoteHashes: voteHashes,
TSpendHashes: tspendHashes,
MixPRHashes: mixPRHashes,
BlockHashes: blockHashes,
VoteHashes: voteHashes,
TSpendHashes: tspendHashes,
MixPairReqHashes: mixPairReqHashes,
}, nil
}
40 changes: 20 additions & 20 deletions wire/msginitstate_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ func TestInitStateWire(t *testing.T) {
0x00, // Varint for number of blocks
0x00, // Varint for number of votes
0x00, // Varint for number of tspends
0x00, // Varint for number of mixprs
0x00, // Varint for number of mixpairreqs
}

fakeBlock1, _ := chainhash.NewHashFromStr("4433221144332211443322114" +
Expand All @@ -138,11 +138,11 @@ func TestInitStateWire(t *testing.T) {
"999999999999999999991199999999999999919")
fakeTSpend3, _ := chainhash.NewHashFromStr("aaaaaaaaaaaa9200aaaaaa" +
"aaaaaaaaaaaaaaaaaaa9a9a9aaaaaaaaaaaaaaa")
fakeMixPR1, _ := chainhash.NewHashFromStr("bbbbbbbbbbbb9200bbbbbb" +
fakeMixPairReq1, _ := chainhash.NewHashFromStr("bbbbbbbbbbbb9200bbbbbb" +
"bbbbbbbbbbbbbbbbbbb9b9b9bbbbbbbbbbbbbbb")
fakeMixPR2, _ := chainhash.NewHashFromStr("cccccccccccc9200cccccc" +
fakeMixPairReq2, _ := chainhash.NewHashFromStr("cccccccccccc9200cccccc" +
"ccccccccccccccccccc9c9c9ccccccccccccccc")
fakeMixPR3, _ := chainhash.NewHashFromStr("dddddddddddd9200dddddd" +
fakeMixPairReq3, _ := chainhash.NewHashFromStr("dddddddddddd9200dddddd" +
"ddddddddddddddddddd9d9d9ddddddddddddddd")

// MsgInitState message with multiple values for each hash.
Expand All @@ -155,9 +155,9 @@ func TestInitStateWire(t *testing.T) {
multiData.AddTSpendHash(fakeTSpend1)
multiData.AddTSpendHash(fakeTSpend2)
multiData.AddTSpendHash(fakeTSpend3)
multiData.AddMixPRHash(fakeMixPR1)
multiData.AddMixPRHash(fakeMixPR2)
multiData.AddMixPRHash(fakeMixPR3)
multiData.AddMixPairReqHash(fakeMixPairReq1)
multiData.AddMixPairReqHash(fakeMixPairReq2)
multiData.AddMixPairReqHash(fakeMixPairReq3)

multiDataEncoded := []byte{
0x02, // Varint for number of block hashes
Expand Down Expand Up @@ -196,15 +196,15 @@ func TestInitStateWire(t *testing.T) {
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0x0a, 0x20,
0xa9, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0x0a, 0x00,
0x03, // Varint for number of mixpr hashes
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0x9b, // Fake mixpr 1
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0x9b, // Fake mixpairreq 1
0x9b, 0x9b, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0x0b, 0x20,
0xb9, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0x0b, 0x00,
0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0x9c, // Fake mixpr 2
0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0x9c, // Fake mixpairreq 2
0x9c, 0x9c, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc,
0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0x0c, 0x20,
0xc9, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0x0c, 0x00,
0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0x9d, // Fake mixpr 3
0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0x9d, // Fake mixpairreq 3
0x9d, 0x9d, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd,
0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0x0d, 0x20,
0xd9, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0x0d, 0x00,
Expand Down Expand Up @@ -278,11 +278,11 @@ func TestInitStateWireErrors(t *testing.T) {
"999999999999999999991199999999999999919")
fakeTSpend3, _ := chainhash.NewHashFromStr("aaaaaaaaaaaa9200aaaaaa" +
"aaaaaaaaaaaaaaaaaaa9a9a9aaaaaaaaaaaaaaa")
fakeMixPR1, _ := chainhash.NewHashFromStr("bbbbbbbbbbbb9200bbbbbb" +
fakeMixPairReq1, _ := chainhash.NewHashFromStr("bbbbbbbbbbbb9200bbbbbb" +
"bbbbbbbbbbbbbbbbbbb9b9b9bbbbbbbbbbbbbbb")
fakeMixPR2, _ := chainhash.NewHashFromStr("cccccccccccc9200cccccc" +
fakeMixPairReq2, _ := chainhash.NewHashFromStr("cccccccccccc9200cccccc" +
"ccccccccccccccccccc9c9c9ccccccccccccccc")
fakeMixPR3, _ := chainhash.NewHashFromStr("dddddddddddd9200dddddd" +
fakeMixPairReq3, _ := chainhash.NewHashFromStr("dddddddddddd9200dddddd" +
"ddddddddddddddddddd9d9d9ddddddddddddddd")

// MsgInitState message with multiple values for each hash.
Expand All @@ -295,9 +295,9 @@ func TestInitStateWireErrors(t *testing.T) {
baseMsg.AddTSpendHash(fakeTSpend1)
baseMsg.AddTSpendHash(fakeTSpend2)
baseMsg.AddTSpendHash(fakeTSpend3)
baseMsg.AddMixPRHash(fakeMixPR1)
baseMsg.AddMixPRHash(fakeMixPR2)
baseMsg.AddMixPRHash(fakeMixPR3)
baseMsg.AddMixPairReqHash(fakeMixPairReq1)
baseMsg.AddMixPairReqHash(fakeMixPairReq2)
baseMsg.AddMixPairReqHash(fakeMixPairReq3)

baseMsgEncoded := []byte{
0x02, // Varint for number of block hashes
Expand Down Expand Up @@ -335,16 +335,16 @@ func TestInitStateWireErrors(t *testing.T) {
0x9a, 0x9a, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0x0a, 0x20,
0xa9, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0x0a, 0x00,
0x03, // Varint for number of mixpr hashes
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0x9b, // Fake mixpr 1
0x03, // Varint for number of mixpairreq hashes
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0x9b, // Fake mixpairreq 1
0x9b, 0x9b, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0x0b, 0x20,
0xb9, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0x0b, 0x00,
0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0x9c, // Fake mixpr 2
0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0x9c, // Fake mixpairreq 2
0x9c, 0x9c, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc,
0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0x0c, 0x20,
0xc9, 0xcc, 0xcc, 0xcc, 0xcc, 0xcc, 0x0c, 0x00,
0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0x9d, // Fake mixpr 3
0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0x9d, // Fake mixpairreq 3
0x9d, 0x9d, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd,
0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0x0d, 0x20,
0xd9, 0xdd, 0xdd, 0xdd, 0xdd, 0xdd, 0x0d, 0x00,
Expand Down

0 comments on commit 96ff57d

Please sign in to comment.