Skip to content
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

Rename NodeInfo's publicKey and nodePublicKey #245

Open
fboucquez opened this issue Nov 16, 2020 · 1 comment
Open

Rename NodeInfo's publicKey and nodePublicKey #245

fboucquez opened this issue Nov 16, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@fboucquez
Copy link
Contributor

Regarding the names, I prefer names that are useful to the user, not based on where the property comes from.
For instance, I don't know if the user is familiar enough with the concept of Certificate Authority. Is this the key used for signing new blocks? Can we call it something like signingPublicKey or harvestingPublicKey?
Regarding nodePublicKey, this is also confusing, since all these keys are related to the node somehow. This is the key used to activate Delegated Harvesting, and it relates to TLS somehow, right? Can we call it something like communicationPublicKey, tlsPublicKey, transamissionPublicKey, networkPublicKey, ... ?

Originally posted by @segfaultxavi in #244 (comment)

@fboucquez fboucquez changed the title Rename node's info publicKey and nodePublicKey Rename NodeInfo's publicKey and nodePublicKey Nov 16, 2020
@fboucquez
Copy link
Contributor Author

fboucquez commented Nov 16, 2020

About publicKey, nodePublicKey names. There are not good enough but we don't want to break too much.

The renames would need to be done in another PR until we have all the upgrades in place at least from server and rest.

nemtech/catapult-server#110

What would it be good candidates from them? It seems like they have multiple uses.

Maaaybe:

publicKey => caPublicKey / mainPublicKey = coming from ca.pem.key file, the node main account public key, and certificate authority.
nodePublicKey => nodePublicKey / communicationPublicKey = coming for node.pem.key file required for communication and delegate harvesting

@rg911 rg911 added the enhancement New feature or request label Feb 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants