From 08da615203d61ae8660bfb75631df57f40fd90a2 Mon Sep 17 00:00:00 2001 From: Yusef Napora Date: Tue, 19 Nov 2019 09:19:17 -0600 Subject: [PATCH] rename Equals -> Equal, add some comments --- crypto/envelope.go | 6 +++++- crypto/envelope_test.go | 2 +- peerstore/peerstore.go | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/crypto/envelope.go b/crypto/envelope.go index 359cf18..6f11b12 100644 --- a/crypto/envelope.go +++ b/crypto/envelope.go @@ -109,6 +109,7 @@ func (e *SignedEnvelope) Payload() []byte { return e.payload } +// Marshal returns a byte slice containing a serailized protobuf representation of a SignedEnvelope. func (e *SignedEnvelope) Marshal() ([]byte, error) { key, err := PublicKeyToProto(e.publicKey) if err != nil { @@ -123,7 +124,10 @@ func (e *SignedEnvelope) Marshal() ([]byte, error) { return proto.Marshal(&msg) } -func (e *SignedEnvelope) Equals(other *SignedEnvelope) bool { +// Equal returns true if the other SignedEnvelope has the same +// public key, payload, payload type, and signature. This +// implies that they were also created with the same domain string. +func (e *SignedEnvelope) Equal(other *SignedEnvelope) bool { return e.publicKey.Equals(other.publicKey) && bytes.Compare(e.payloadType, other.payloadType) == 0 && bytes.Compare(e.payload, other.payload) == 0 && diff --git a/crypto/envelope_test.go b/crypto/envelope_test.go index 10ba891..552f6cf 100644 --- a/crypto/envelope_test.go +++ b/crypto/envelope_test.go @@ -45,7 +45,7 @@ func TestEnvelopeHappyPath(t *testing.T) { t.Error("payload of envelope does not match input") } - if !envelope.Equals(deserialized) { + if !envelope.Equal(deserialized) { t.Error("round-trip serde results in unequal envelope structures") } } diff --git a/peerstore/peerstore.go b/peerstore/peerstore.go index b12b62f..3e12a29 100644 --- a/peerstore/peerstore.go +++ b/peerstore/peerstore.go @@ -98,7 +98,7 @@ type AddrBook interface { // AddCertifiedAddrs adds addresses from a routing.RoutingState record // contained in a serialized SignedEnvelope. - AddCertifiedAddrs(envelopeBytes []byte, ttl time.Duration) error + AddCertifiedAddrs(envelope []byte, ttl time.Duration) error // SetAddr calls mgr.SetAddrs(p, addr, ttl) SetAddr(p peer.ID, addr ma.Multiaddr, ttl time.Duration)