You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

61 lines
2.2 KiB

privval: improve Remote Signer implementation (#3351) This issue is related to #3107 This is a first renaming/refactoring step before reworking and removing heartbeats. As discussed with @Liamsi , we preferred to go for a couple of independent and separate PRs to simplify review work. The changes: Help to clarify the relation between the validator and remote signer endpoints Differentiate between timeouts and deadlines Prepare to encapsulate networking related code behind RemoteSigner in the next PR My intention is to separate and encapsulate the "network related" code from the actual signer. SignerRemote ---(uses/contains)--> SignerValidatorEndpoint <--(connects to)--> SignerServiceEndpoint ---> SignerService (future.. not here yet but would like to decouple too) All reconnection/heartbeat/whatever code goes in the endpoints. Signer[Remote/Service] do not need to know about that. I agree Endpoint may not be the perfect name. I tried to find something "Go-ish" enough. It is a common name in go-kit, kubernetes, etc. Right now: SignerValidatorEndpoint: handles the listener contains SignerRemote Implements the PrivValidator interface connects and sets a connection object in a contained SignerRemote delegates PrivValidator some calls to SignerRemote which in turn uses the conn object that was set externally SignerRemote: Implements the PrivValidator interface read/writes from a connection object directly handles heartbeats SignerServiceEndpoint: Does most things in a single place delegates to a PrivValidator IIRC. * cleanup * Refactoring step 1 * Refactoring step 2 * move messages to another file * mark for future work / next steps * mark deprecated classes in docs * Fix linter problems * additional linter fixes
6 years ago
  1. package privval
  2. import (
  3. amino "github.com/tendermint/go-amino"
  4. "github.com/tendermint/tendermint/crypto"
  5. "github.com/tendermint/tendermint/types"
  6. )
  7. // RemoteSignerMsg is sent between SignerServiceEndpoint and the SignerServiceEndpoint client.
  8. type RemoteSignerMsg interface{}
  9. func RegisterRemoteSignerMsg(cdc *amino.Codec) {
  10. cdc.RegisterInterface((*RemoteSignerMsg)(nil), nil)
  11. cdc.RegisterConcrete(&PubKeyRequest{}, "tendermint/remotesigner/PubKeyRequest", nil)
  12. cdc.RegisterConcrete(&PubKeyResponse{}, "tendermint/remotesigner/PubKeyResponse", nil)
  13. cdc.RegisterConcrete(&SignVoteRequest{}, "tendermint/remotesigner/SignVoteRequest", nil)
  14. cdc.RegisterConcrete(&SignedVoteResponse{}, "tendermint/remotesigner/SignedVoteResponse", nil)
  15. cdc.RegisterConcrete(&SignProposalRequest{}, "tendermint/remotesigner/SignProposalRequest", nil)
  16. cdc.RegisterConcrete(&SignedProposalResponse{}, "tendermint/remotesigner/SignedProposalResponse", nil)
  17. cdc.RegisterConcrete(&PingRequest{}, "tendermint/remotesigner/PingRequest", nil)
  18. cdc.RegisterConcrete(&PingResponse{}, "tendermint/remotesigner/PingResponse", nil)
  19. }
  20. // PubKeyRequest requests the consensus public key from the remote signer.
  21. type PubKeyRequest struct{}
  22. // PubKeyResponse is a PrivValidatorSocket message containing the public key.
  23. type PubKeyResponse struct {
  24. PubKey crypto.PubKey
  25. Error *RemoteSignerError
  26. }
  27. // SignVoteRequest is a PrivValidatorSocket message containing a vote.
  28. type SignVoteRequest struct {
  29. Vote *types.Vote
  30. }
  31. // SignedVoteResponse is a PrivValidatorSocket message containing a signed vote along with a potenial error message.
  32. type SignedVoteResponse struct {
  33. Vote *types.Vote
  34. Error *RemoteSignerError
  35. }
  36. // SignProposalRequest is a PrivValidatorSocket message containing a Proposal.
  37. type SignProposalRequest struct {
  38. Proposal *types.Proposal
  39. }
  40. // SignedProposalResponse is a PrivValidatorSocket message containing a proposal response
  41. type SignedProposalResponse struct {
  42. Proposal *types.Proposal
  43. Error *RemoteSignerError
  44. }
  45. // PingRequest is a PrivValidatorSocket message to keep the connection alive.
  46. type PingRequest struct {
  47. }
  48. // PingRequest is a PrivValidatorSocket response to keep the connection alive.
  49. type PingResponse struct {
  50. }