renames secretName to participantName #4927
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andiflabs
reviewed
Apr 23, 2024
| }), | ||
| identity: Flags.string({ | ||
| char: 'i', | ||
| description: | ||
| 'The identity of the participants will generate the group keys (may be specified multiple times to add multiple participants). Must include the identity for secretName', | ||
| 'The identity of the participants will generate the group keys (may be specified multiple times to add multiple participants). Must include the identity for participantName', |
There was a problem hiding this comment.
(Does not need to be addressed here)
"Must include hte identity for participantName" << is this really true? Don't we add it automatically if omitted?
There was a problem hiding this comment.
Good catch! It's a small change, so I'll make it here
andiflabs
approved these changes
Apr 23, 2024
rohanjadvani
approved these changes
Apr 23, 2024
the term 'secretName' does not make it clear that the name should be the same as the one used with 'participant:create', that is, the name of a participant renames the flag and rpc parameter 'secretName' to 'participantName' across all dkg cli commands and rpc endpoints changes flag character from s to n. in round3, this also requires changing the 'accountName' flag character from n to a adds an alias 'name' for 'participantName' in all dkg commands
hughy
force-pushed
the
feat/hughy/ifl-2516/dkg-participant-name
branch
from
00a8653 to
81d61da
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
the term 'secretName' does not make it clear that the name should be the same as the one used with 'participant:create', that is, the name of a participant
renames the flag and rpc parameter 'secretName' to 'participantName' across all dkg cli commands and rpc endpoints
changes flag character from s to n. in round3, this also requires changing the 'accountName' flag character from n to a
adds an alias 'name' for 'participantName' in all dkg commands
Testing Plan
manual testing: created an account by running all three dkg rounds
Documentation
Does this change require any updates to the Iron Fish Docs (ex. the RPC API
Reference)? If yes, link a
related documentation pull request for the website.
Breaking Change
Is this a breaking change? If yes, add notes below on why this is breaking and label it with
breaking-change-rpcorbreaking-change-sdk.