mirror of
https://github.com/fluencelabs/tendermint
synced 2025-04-25 06:42:16 +00:00
853dd34d31
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
82 lines
2.1 KiB
Go
82 lines
2.1 KiB
Go
package privval
|
|
|
|
import (
|
|
"io/ioutil"
|
|
"os"
|
|
|
|
"github.com/tendermint/tendermint/crypto"
|
|
cmn "github.com/tendermint/tendermint/libs/common"
|
|
"github.com/tendermint/tendermint/types"
|
|
)
|
|
|
|
// OldFilePV is the old version of the FilePV, pre v0.28.0.
|
|
// Deprecated: Use FilePV instead.
|
|
type OldFilePV struct {
|
|
Address types.Address `json:"address"`
|
|
PubKey crypto.PubKey `json:"pub_key"`
|
|
LastHeight int64 `json:"last_height"`
|
|
LastRound int `json:"last_round"`
|
|
LastStep int8 `json:"last_step"`
|
|
LastSignature []byte `json:"last_signature,omitempty"`
|
|
LastSignBytes cmn.HexBytes `json:"last_signbytes,omitempty"`
|
|
PrivKey crypto.PrivKey `json:"priv_key"`
|
|
|
|
filePath string
|
|
}
|
|
|
|
// LoadOldFilePV loads an OldFilePV from the filePath.
|
|
func LoadOldFilePV(filePath string) (*OldFilePV, error) {
|
|
pvJSONBytes, err := ioutil.ReadFile(filePath)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
pv := &OldFilePV{}
|
|
err = cdc.UnmarshalJSON(pvJSONBytes, &pv)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// overwrite pubkey and address for convenience
|
|
pv.PubKey = pv.PrivKey.PubKey()
|
|
pv.Address = pv.PubKey.Address()
|
|
|
|
pv.filePath = filePath
|
|
return pv, nil
|
|
}
|
|
|
|
// Upgrade convets the OldFilePV to the new FilePV, separating the immutable and mutable components,
|
|
// and persisting them to the keyFilePath and stateFilePath, respectively.
|
|
// It renames the original file by adding ".bak".
|
|
func (oldFilePV *OldFilePV) Upgrade(keyFilePath, stateFilePath string) *FilePV {
|
|
privKey := oldFilePV.PrivKey
|
|
pvKey := FilePVKey{
|
|
PrivKey: privKey,
|
|
PubKey: privKey.PubKey(),
|
|
Address: privKey.PubKey().Address(),
|
|
filePath: keyFilePath,
|
|
}
|
|
|
|
pvState := FilePVLastSignState{
|
|
Height: oldFilePV.LastHeight,
|
|
Round: oldFilePV.LastRound,
|
|
Step: oldFilePV.LastStep,
|
|
Signature: oldFilePV.LastSignature,
|
|
SignBytes: oldFilePV.LastSignBytes,
|
|
filePath: stateFilePath,
|
|
}
|
|
|
|
// Save the new PV files
|
|
pv := &FilePV{
|
|
Key: pvKey,
|
|
LastSignState: pvState,
|
|
}
|
|
pv.Save()
|
|
|
|
// Rename the old PV file
|
|
err := os.Rename(oldFilePV.filePath, oldFilePV.filePath+".bak")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return pv
|
|
}
|