Signed envelopes & routing records

crypto/pb/Makefile

@@ -4,7 +4,7 @@ GO = $(PB:.proto=.pb.go)
 all: $(GO)
 
 %.pb.go: %.proto
-		protoc --proto_path=$(GOPATH)/src:. --gogofaster_out=. $<
+		protoc --proto_path=$(PWD)/../..:. --gogofaster_out=. $<
 
 clean:
 		rm -f *.pb.go

crypto/pb/crypto.proto

@@ -2,6 +2,8 @@ syntax = "proto2";
 
 package crypto.pb;
 
+option go_package = "github.com/libp2p/go-libp2p-core/crypto/pb";
+
 enum KeyType {
 	RSA = 0;
 	Ed25519 = 1;

event/addrs.go

@@ -0,0 +1,82 @@
+package event
+
+import (
+	"github.com/libp2p/go-libp2p-core/record"
+	ma "github.com/multiformats/go-multiaddr"
+)
+
+// AddrAction represents an action taken on one of a Host's listen addresses.
+// It is used to add context to address change events in EvtLocalAddressesUpdated.
+type AddrAction int
+
+const (
+	// Unknown means that the event producer was unable to determine why the address
+	// is in the current state.
+	Unknown AddrAction = iota
+
+	// Added means that the address is new and was not present prior to the event.
+	Added
+
+	// Maintained means that the address was not altered between the current and
+	// previous states.
+	Maintained
+
+	// Removed means that the address was removed from the Host.
+	Removed
+)
+
+// UpdatedAddress is used in the EvtLocalAddressesUpdated event to convey
+// address change information.
+type UpdatedAddress struct {
+	// Address contains the address that was updated.
+	Address ma.Multiaddr
+
+	// Action indicates what action was taken on the address during the
+	// event. May be Unknown if the event producer cannot produce diffs.
+	Action AddrAction
+}
+
+// EvtLocalAddressesUpdated should be emitted when the set of listen addresses for
+// the local host changes. This may happen for a number of reasons. For example,
+// we may have opened a new relay connection, established a new NAT mapping via
+// UPnP, or been informed of our observed address by another peer.
+//
+// EvtLocalAddressesUpdated contains a snapshot of the current listen addresses,
+// and may also contain a diff between the current state and the previous state.
+// If the event producer is capable of creating a diff, the Diffs field will be
+// true, and event consumers can inspect the Action field of each UpdatedAddress
+// to see how each address was modified.
+//
+// For example, the Action will tell you whether an address in
+// the Current list was Added by the event producer, or was Maintained without
+// changes. Addresses that were removed from the Host will have the AddrAction
+// of Removed, and will be in the Removed list.
+//
+// If the event producer is not capable or producing diffs, the Diffs field will
+// be false, the Removed list will always be empty, and the Action for each
+// UpdatedAddress in the Current list will be Unknown.
+type EvtLocalAddressesUpdated struct {
+
+	// Diffs indicates whether this event contains a diff of the Host's previous
+	// address set.
+	Diffs bool
+
+	// Current contains all current listen addresses for the Host.
+	// If Diffs == true, the Action field of each UpdatedAddress will tell
+	// you whether an address was Added, or was Maintained from the previous
+	// state.
+	Current []UpdatedAddress
+
+	// Removed contains addresses that were removed from the Host.
+	// This field is only set when Diffs == true.
+	Removed []UpdatedAddress
+}
+
+// EvtLocalPeerRoutingStateUpdated should be emitted when a new signed PeerRecord
+// for the local peer has been produced. This will happen whenever the set of listen
+// addresses changes.
+type EvtLocalPeerRecordUpdated struct {
+	// Record contains the updated peer.PeerRecord, wrapped in a record.Envelope and
+	// signed by the Host's private key.
+	Record *record.Envelope
+}

go.mod

@@ -6,12 +6,14 @@ require (
 	github.com/gogo/protobuf v1.3.1
 	github.com/ipfs/go-cid v0.0.4
 	github.com/jbenet/goprocess v0.1.3
+	github.com/libp2p/go-buffer-pool v0.0.1
 	github.com/libp2p/go-flow-metrics v0.0.3
 	github.com/libp2p/go-openssl v0.0.4
 	github.com/minio/sha256-simd v0.1.1
 	github.com/mr-tron/base58 v1.1.3
 	github.com/multiformats/go-multiaddr v0.2.0
 	github.com/multiformats/go-multihash v0.0.13
+	github.com/multiformats/go-varint v0.0.5
 	github.com/smola/gocompat v0.2.0
 	go.opencensus.io v0.22.2
 )

peer/pb/Makefile

@@ -0,0 +1,11 @@
+PB = $(wildcard *.proto)
+GO = $(PB:.proto=.pb.go)
+
+all: $(GO)
+
+%.pb.go: %.proto
+		protoc --proto_path=$(PWD):$(PWD)/../.. --gogofaster_out=. $<
+
+clean:
+		rm -f *.pb.go
+		rm -f *.go