-
Notifications
You must be signed in to change notification settings - Fork 131
dkg: add nickname flag
#4105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
dkg: add nickname flag
#4105
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a --nickname flag to the DKG command to allow operators to set human-friendly peer identifiers. When peers connect via the sync protocol, their nicknames are exchanged and logged, improving the operator experience by making peer connections more recognizable.
Key Changes
- Added
nicknamefield to the DKG sync protocol (protobuf message) - Peers send and display nicknames when connecting during DKG ceremony
- Flag includes validation for a 32-character maximum length
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
cmd/dkg.go |
Adds --nickname CLI flag with 32-character validation |
dkg/dkg.go |
Passes nickname through to sync protocol initialization |
dkg/protocol.go |
Forwards nickname parameter to startSyncProtocol |
dkg/sync/client.go |
Stores nickname as immutable state and includes it in sync messages |
dkg/sync/server.go |
Extracts nickname from incoming messages and includes it in connection logs |
dkg/sync/sync_test.go |
Updates tests to initialize nicknames for all test nodes |
dkg/dkgpb/v1/sync.proto |
Adds nickname field to MsgSync protobuf message |
dkg/dkgpb/v1/sync.pb.go |
Generated protobuf code for nickname field |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4105 +/- ##
==========================================
+ Coverage 56.37% 56.39% +0.02%
==========================================
Files 245 245
Lines 31169 31183 +14
==========================================
+ Hits 17571 17586 +15
- Misses 11284 11291 +7
+ Partials 2314 2306 -8 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| Shutdown bool `protobuf:"varint,3,opt,name=shutdown,proto3" json:"shutdown,omitempty"` | ||
| Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"` | ||
| Step int64 `protobuf:"varint,5,opt,name=step,proto3" json:"step,omitempty"` | ||
| Nickname string `protobuf:"bytes,6,opt,name=nickname,proto3" json:"nickname,omitempty"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to note that this will make it incompatible with previous versions.
Either way we allow DKG only with the same MAJOR.MINOR, so it's not something new.



Add
--nicknameflag to DKG.Peers will send their nickname via
syncprotocol which will be logged upon connecting for the first time:category: feature
ticket: #4059