github.com/vipernet-xyz/tm@v0.34.24/privval/doc.go (about)

     1  /*
     2  Package privval provides different implementations of the types.PrivValidator.
     3  
     4  # FilePV
     5  
     6  FilePV is the simplest implementation and developer default.
     7  It uses one file for the private key and another to store state.
     8  
     9  # SignerListenerEndpoint
    10  
    11  SignerListenerEndpoint establishes a connection to an external process,
    12  like a Key Management Server (KMS), using a socket.
    13  SignerListenerEndpoint listens for the external KMS process to dial in.
    14  SignerListenerEndpoint takes a listener, which determines the type of connection
    15  (ie. encrypted over tcp, or unencrypted over unix).
    16  
    17  # SignerDialerEndpoint
    18  
    19  SignerDialerEndpoint is a simple wrapper around a net.Conn. It's used by both IPCVal and TCPVal.
    20  
    21  # SignerClient
    22  
    23  SignerClient handles remote validator connections that provide signing services.
    24  In production, it's recommended to wrap it with RetrySignerClient to avoid
    25  termination in case of temporary errors.
    26  */
    27  package privval