Skip to content

Commit 6de96b0

Browse files
paralinparalin
committed
refactor: libp2p dropped peer-id pretty
Signed-off-by: Christian Stewart <[email protected]>
1 parent 815aac4 commit 6de96b0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+156
-156
lines changed

‎agent/controller/controller.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func (c *Controller) GetControllerInfo() *controller.Info {
6868
return controller.NewInfo(
6969
ControllerID,
7070
Version,
71-
"agent controller "+c.GetPeerID().Pretty(),
71+
"agent controller "+c.GetPeerID().String(),
7272
)
7373
}
7474

‎agent/directive.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func (d *AttachAgentToNodeSingleton) GetName() string {
7272
func (d *AttachAgentToNodeSingleton) GetDebugVals() directive.DebugValues {
7373
vals := directive.DebugValues{}
7474
if pid := d.AttachAgentToNodeID(); pid != peer.ID("") {
75-
vals["node-id"] = []string{pid.Pretty()}
75+
vals["node-id"] = []string{pid.String()}
7676
}
7777
return vals
7878
}

‎cli/client_subscribe.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func (a *ClientArgs) RunSubscribe(_ *cli.Context) error {
3838
if err != nil {
3939
return err
4040
}
41-
a.SubscribeConf.PeerId = pid.Pretty()
41+
a.SubscribeConf.PeerId = pid.String()
4242
a.SubscribeConf.PrivKeyPem = string(pkdat)
4343
}
4444

‎cli/dialeraddrs.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ func parseDialerAddrs(ss cli.StringSlice) (map[string]*dialer.DialerOpts, error)
2424
if pid == peer.ID("") {
2525
continue
2626
}
27-
m[pid.Pretty()] = &dialer.DialerOpts{
27+
m[pid.String()] = &dialer.DialerOpts{
2828
Address: strings.TrimSpace(pair[1]),
2929
}
3030
}

‎cli/util/util.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ func (a *UtilArgs) RunGeneratePrivate(_ *cli.Context) error {
5555
return err
5656
}
5757
le := a.GetLogger()
58-
le.Infof("generated private key: %s", npeer.GetPeerID().Pretty())
58+
le.Infof("generated private key: %s", npeer.GetPeerID().String())
5959
return nil
6060
}
6161

@@ -142,7 +142,7 @@ func (a *UtilArgs) readInputFilePrivKey() (peer.Peer, error) {
142142
if err != nil {
143143
return nil, err
144144
}
145-
le.Debugf("loaded private key: %s", npeer.GetPeerID().Pretty())
145+
le.Debugf("loaded private key: %s", npeer.GetPeerID().String())
146146
return npeer, nil
147147
}
148148

@@ -163,7 +163,7 @@ func (a *UtilArgs) readInputFilePubKey() (peer.Peer, error) {
163163
if err != nil {
164164
return nil, err
165165
}
166-
le.Debugf("loaded public key: %s", npeer.GetPeerID().Pretty())
166+
le.Debugf("loaded public key: %s", npeer.GetPeerID().String())
167167
return npeer, nil
168168
}
169169

‎daemon/api/api.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ func (a *API) ForwardStreams(
6666
reqCtxCancel,
6767
)
6868
if err != nil {
69-
return errors.Errorf("peer not loaded: %s", targetPeerID.Pretty())
69+
return errors.Errorf("peer not loaded: %s", targetPeerID.String())
7070
}
7171
defer peerRef.Release()
7272

‎daemon/api/api_pubsub_subscribe.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ func (a *API) Subscribe(serv pubsub_api.SRPCPubSubService_SubscribeStream) error
109109
go func() {
110110
_ = serv.Send(&pubsub_api.SubscribeResponse{
111111
IncomingMessage: &pubsub_api.IncomingMessage{
112-
FromPeerId: m.GetFrom().Pretty(),
112+
FromPeerId: m.GetFrom().String(),
113113
Data: m.GetData(),
114114
Authenticated: m.GetAuthenticated(),
115115
},

‎daemon/daemon.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ type Daemon struct {
2929
nodePriv crypto.PrivKey
3030
// nodePeerID is the primary node ID
3131
nodePeerID peer.ID
32-
// nodePeerIDPretty is the node peer ID as a b58 address
33-
nodePeerIDPretty string
32+
// nodePeerIDString is the node peer ID as a b58 address
33+
nodePeerIDString string
3434

3535
// closeCbs are funcs to call when we close the daemon
3636
closeCbs []func()
@@ -79,7 +79,7 @@ func NewDaemon(
7979
return nil, err
8080
}
8181

82-
peerIDPretty := peerID.Pretty()
82+
peerIDString := peerID.String()
8383
nodePrivKeyPem, err := keypem.MarshalPrivKeyPem(nodePriv)
8484
if err != nil {
8585
return nil, err
@@ -92,7 +92,7 @@ func NewDaemon(
9292
if err != nil {
9393
return nil, err
9494
}
95-
le.Debugf("node controller resolved w/ ID: %s", peerIDPretty)
95+
le.Debugf("node controller resolved w/ ID: %s", peerIDString)
9696

9797
return &Daemon{
9898
bus: b,
@@ -103,7 +103,7 @@ func NewDaemon(
103103
nodePriv: nodePriv,
104104
nodePeerID: peerID,
105105
staticResolver: sr,
106-
nodePeerIDPretty: peerIDPretty,
106+
nodePeerIDString: peerIDString,
107107
}, nil
108108
}
109109

‎entitygraph/peer_entity.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type PeerEntity struct {
1515

1616
// NewPeerEntityRef constructs a new entity ref to a node.
1717
func NewPeerEntityRef(peerID peer.ID) entity.Ref {
18-
return entity.NewEntityRefWithID(peerID.Pretty(), PeerEntityTypeName)
18+
return entity.NewEntityRefWithID(peerID.String(), PeerEntityTypeName)
1919
}
2020

2121
// NewPeerEntity constructs a new PeerEntity.

‎examples/nats-host/main.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ func runNatsExample(c *cli.Context) error {
8888
for _, peer := range g.AllPeers() {
8989
peer.AddFactory(func(b bus.Bus) controller.Factory { return nats_controller.NewFactory(b) })
9090
peer.AddConfig("pubsub", &nats_controller.Config{
91-
PeerId: peer.GetPeerID().Pretty(),
91+
PeerId: peer.GetPeerID().String(),
9292
NatsConfig: &nats.Config{
9393
LogTrace: logTrace,
9494
},
@@ -111,8 +111,8 @@ func runNatsExample(c *cli.Context) error {
111111
} else {
112112
le.Infof(
113113
"successful connectivity test between %s and %s",
114-
p0.GetPeerID().Pretty(),
115-
p1.GetPeerID().Pretty(),
114+
p0.GetPeerID().String(),
115+
p1.GetPeerID().String(),
116116
)
117117
}
118118
}
@@ -163,7 +163,7 @@ func runNatsExample(c *cli.Context) error {
163163
// TODO: remove this delay... needs a little time to "settle"
164164
<-time.After(time.Millisecond * 200)
165165
testReplicate := func() {
166-
le.Infof("publishing data on p2 with peer %s", p2.GetPeerID().Pretty())
166+
le.Infof("publishing data on p2 with peer %s", p2.GetPeerID().String())
167167
s2.Publish(testingData)
168168
rmsg := <-msgRx
169169
if bytes.Compare(rmsg.GetData(), testingData) != 0 {

‎examples/nats-host/nats-single/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ func runNatsExample(c *cli.Context) error {
7474
for _, peer := range g.AllPeers() {
7575
peer.AddFactory(func(b bus.Bus) controller.Factory { return nats_controller.NewFactory(b) })
7676
peer.AddConfig("pubsub", &nats_controller.Config{
77-
PeerId: peer.GetPeerID().Pretty(),
77+
PeerId: peer.GetPeerID().String(),
7878
NatsConfig: &nats.Config{
7979
LogTrace: true,
8080
},

‎examples/udp-link/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func genPeerIdentity() (peer.ID, crypto.PrivKey) {
3131
log.Fatal(err)
3232
}
3333
pid1, _ := peer.IDFromPrivateKey(pk1)
34-
log.Debugf("generated peer id: %s", pid1.Pretty())
34+
log.Debugf("generated peer id: %s", pid1.String())
3535

3636
return pid1, pk1
3737
}

‎examples/websocket-browser-link/common/common.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func genPeerIdentity(peerSeed string) (peer.ID, crypto.PrivKey) {
3535
log.Fatal(err)
3636
}
3737
pid1, _ := peer.IDFromPrivateKey(pk1)
38-
log.Debugf("generated insecure peer id: %s", pid1.Pretty())
38+
log.Debugf("generated insecure peer id: %s", pid1.String())
3939

4040
return pid1, pk1
4141
}
@@ -61,7 +61,7 @@ func BuildCommonBus(ctx context.Context, peerSeed string) (bus.Bus, crypto.PrivK
6161
sr.AddFactory(link_holdopen_controller.NewFactory(b))
6262
sr.AddFactory(nats_controller.NewFactory(b))
6363

64-
le = le.WithField("peer-id", peerID.Pretty())
64+
le = le.WithField("peer-id", peerID.String())
6565
le.Debug("constructing node")
6666
_, _, err = b.AddDirective(
6767
resolver.NewLoadControllerWithConfig(&nctr.Config{
@@ -87,7 +87,7 @@ func BuildCommonBus(ctx context.Context, peerSeed string) (bus.Bus, crypto.PrivK
8787

8888
// use pubsub: nats
8989
_, _, err = b.AddDirective(resolver.NewLoadControllerWithConfig(&nats_controller.Config{
90-
PeerId: peerID.Pretty(),
90+
PeerId: peerID.String(),
9191
NatsConfig: &nats.Config{LogTrace: true},
9292
}), nil)
9393
if err != nil {

‎examples/websocket-browser-link/server/server.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func run() error {
6767
if !m.GetAuthenticated() || from == localPeerID {
6868
return
6969
}
70-
le.Infof("got pubsub message from %s: %s", from.Pretty(), string(m.GetData()))
70+
le.Infof("got pubsub message from %s: %s", from.String(), string(m.GetData()))
7171
})
7272
defer relHandler()
7373

‎link/establish-link.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ func (d *establishLinkWithPeer) GetName() string {
9595
// This is not necessarily unique, and is primarily intended for display.
9696
func (d *establishLinkWithPeer) GetDebugVals() directive.DebugValues {
9797
vals := directive.NewDebugValues()
98-
vals["peer-id"] = []string{d.EstablishLinkTargetPeerId().Pretty()}
98+
vals["peer-id"] = []string{d.EstablishLinkTargetPeerId().String()}
9999
if src := d.EstablishLinkSourcePeerId(); len(src) != 0 {
100-
vals["from-peer-id"] = []string{d.EstablishLinkSourcePeerId().Pretty()}
100+
vals["from-peer-id"] = []string{d.EstablishLinkSourcePeerId().String()}
101101
}
102102
return vals
103103
}

‎link/establish/controller.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func NewController(b bus.Bus, le *logrus.Entry, peers []peer.ID, srcID peer.ID)
5050
// Returning an error triggers a retry with backoff.
5151
func (c *Controller) Execute(ctx context.Context) error {
5252
for _, peerID := range c.peers {
53-
le := c.le.WithField("peer-id", peerID.Pretty())
53+
le := c.le.WithField("peer-id", peerID.String())
5454
_, diRef, err := c.bus.AddDirective(
5555
link.NewEstablishLinkWithPeer(c.srcPeerID, peerID),
5656
nil,

‎link/handle-mounted-stream.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ func (d *handleMountedStream) GetName() string {
121121
func (d *handleMountedStream) GetDebugVals() directive.DebugValues {
122122
vals := directive.DebugValues{}
123123
vals["protocol-id"] = []string{string(d.HandleMountedStreamProtocolID())}
124-
vals["local-peer"] = []string{d.HandleMountedStreamLocalPeerID().Pretty()}
125-
vals["remote-peer"] = []string{d.HandleMountedStreamRemotePeerID().Pretty()}
124+
vals["local-peer"] = []string{d.HandleMountedStreamLocalPeerID().String()}
125+
vals["remote-peer"] = []string{d.HandleMountedStreamRemotePeerID().String()}
126126
return vals
127127
}
128128

‎link/hold-open/establish_link.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ func newEstablishLinkHandler(
4040
return &establishLinkHandler{
4141
c: c,
4242
di: di,
43-
le: le.WithField("peer-id", peerID.Pretty()),
43+
le: le.WithField("peer-id", peerID.String()),
4444
peerID: peerID,
4545
}
4646
}
@@ -59,7 +59,7 @@ func (e *establishLinkHandler) HandleValueAdded(inst directive.Instance, val dir
5959
if nrr {
6060
e.le.
6161
WithField("link-uuid", vl.GetUUID()).
62-
WithField("local-peer", vl.GetLocalPeer().Pretty()).
62+
WithField("local-peer", vl.GetLocalPeer().String()).
6363
Debug("starting peer hold-open tracking")
6464
go func() {
6565
e.mtx.Lock()

‎link/open-stream.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ func (d *openStreamWithPeer) GetName() string {
132132
func (d *openStreamWithPeer) GetDebugVals() directive.DebugValues {
133133
vals := directive.NewDebugValues()
134134
vals["protocol-id"] = []string{string(d.OpenStreamWPProtocolID())}
135-
vals["target-peer"] = []string{d.OpenStreamWPTargetPeerID().Pretty()}
136-
vals["source-peer"] = []string{d.OpenStreamWPSourcePeerID().Pretty()}
135+
vals["target-peer"] = []string{d.OpenStreamWPTargetPeerID().String()}
136+
vals["source-peer"] = []string{d.OpenStreamWPSourcePeerID().String()}
137137
if tpt := d.OpenStreamWPTransportConstraint(); tpt != 0 {
138138
vals["transport"] = []string{strconv.FormatUint(tpt, 10)}
139139
}

‎peer/controller/controller.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func NewController(le *logrus.Entry, p peer.Peer) *Controller {
3939
// Returning nil ends execution.
4040
// Returning an error triggers a retry with backoff.
4141
func (c *Controller) Execute(ctx context.Context) error {
42-
c.le.WithField("peer-id", c.GetPeerID().Pretty()).Debug("peer mounted")
42+
c.le.WithField("peer-id", c.GetPeerID().String()).Debug("peer mounted")
4343
// TODO: loopback controller
4444
return nil
4545
}
@@ -66,7 +66,7 @@ func (c *Controller) GetControllerInfo() *controller.Info {
6666
return controller.NewInfo(
6767
ControllerID,
6868
Version,
69-
"peer controller "+c.GetPeerID().Pretty(),
69+
"peer controller "+c.GetPeerID().String(),
7070
)
7171
}
7272

‎peer/controller/controller_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func TestPrivKeyIntegrity(t *testing.T) {
3939
t.Fatal(err.Error())
4040
}
4141
cctrl := ctrl.(*Controller)
42-
if privKeyID.Pretty() != cctrl.GetPeerID().Pretty() {
43-
t.Fatalf("priv key id mismatch: %s != %s", privKeyID.Pretty(), cctrl.GetPeerID().Pretty())
42+
if privKeyID.String() != cctrl.GetPeerID().String() {
43+
t.Fatalf("priv key id mismatch: %s != %s", privKeyID.String(), cctrl.GetPeerID().String())
4444
}
4545
}

‎peer/derive_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ func TestDerive(t *testing.T) {
3333
if err != nil {
3434
t.Fatal(err.Error())
3535
}
36-
t.Logf("keys[%d]: derived private key: %s", ki, derivPrivID.Pretty())
36+
t.Logf("keys[%d]: derived private key: %s", ki, derivPrivID.String())
3737
}
3838
}

‎peer/directive.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ func (d *getPeer) GetName() string {
7474
func (d *getPeer) GetDebugVals() directive.DebugValues {
7575
vals := directive.DebugValues{}
7676
if pid := d.GetPeerIDConstraint(); pid != ID("") {
77-
vals["peer-id"] = []string{pid.Pretty()}
77+
vals["peer-id"] = []string{pid.String()}
7878
}
7979
return vals
8080
}

‎peer/encrypt_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ func TestEncrypt(t *testing.T) {
1717
}
1818

1919
// super-secret message
20-
msg := "Hello to " + peerID.Pretty() + "!"
20+
msg := "Hello to " + peerID.String() + "!"
2121
context := "bifrost/peer/encrypt_test super-duper-secret"
2222
dat, err := EncryptToPubKey(pubKey, context, []byte(msg))
2323
if err != nil {

‎peer/peer_addr.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func (a *NetAddr) Network() string {
2121

2222
// String form of address (for example, "192.0.2.1:25", "[2001:db8::1]:80")
2323
func (a *NetAddr) String() string {
24-
return a.pid.Pretty()
24+
return a.pid.String()
2525
}
2626

2727
// _ is a type assertion

‎peer/signed-msg_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func TestSignedMsg(t *testing.T) {
3535
t.Fatal(err.Error())
3636
}
3737
if peerID != exPeerID {
38-
t.Fatalf("peer id mismatch: %s != %s", exPeerID.Pretty(), peerID.Pretty())
38+
t.Fatalf("peer id mismatch: %s != %s", exPeerID.String(), peerID.String())
3939
}
4040

4141
if !bytes.Equal(smsg.Data, []byte(msg)) {

‎pubsub/controller/controller.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ func (c *Controller) Execute(ctx context.Context) error {
155155
lnk: vl,
156156
le: c.le.
157157
WithField("link-uuid", vl.GetUUID()).
158-
WithField("link-remote-peer", vl.GetRemotePeer().Pretty()),
158+
WithField("link-remote-peer", vl.GetRemotePeer().String()),
159159
}
160160
c.links[tpl] = tl
161161
go func() {

‎pubsub/controller/tracked-link.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ type trackedLink struct {
2222
func (t *trackedLink) trackLink(ctx context.Context) error {
2323
// decide which side opens stream using whoever's peer id is greater
2424
// this is deterministic enough, as long as everyone uses the same
25-
// Pretty() implementation.
26-
if t.lnk.GetLocalPeer().Pretty() > t.lnk.GetRemotePeer().Pretty() {
25+
// String() implementation.
26+
if t.lnk.GetLocalPeer().String() > t.lnk.GetRemotePeer().String() {
2727
return nil
2828
}
2929
t.le.Debug("link tracking starting")

‎pubsub/dir-build-channel-subscription.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ func (d *buildChannelSubscription) GetDebugVals() directive.DebugValues {
133133
if pkey != nil {
134134
pid, _ := peer.IDFromPrivateKey(pkey)
135135
if len(pid) != 0 {
136-
vals["peer-id"] = []string{pid.Pretty()}
136+
vals["peer-id"] = []string{pid.String()}
137137
}
138138
}
139139
return vals

0 commit comments

Comments
 (0)