Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

privval

package

Go to main page

Versions in this module

v1

v1.1.3

Mar 4, 2024

v1.1.2

Oct 17, 2023

Changes in this version

type SignerListenerEndpointOption

+ func SignerListenerEndpointAllowAddress(protocol string, allowedAddresses []string) SignerListenerEndpointOption

v1.1.1

Jul 31, 2023

v1.1.0

Apr 21, 2023

Changes in this version

+ var ErrConnectionTimeout = EndpointTimeoutError

+ var ErrDialRetryMax = errors.New("dialed maximum retries")

+ var ErrNoConnection = errors.New("endpoint is not connected")

+ var ErrReadTimeout = errors.New("endpoint read timed out")

+ var ErrUnexpectedResponse = errors.New("empty response")

+ var ErrWriteTimeout = errors.New("endpoint write timed out")

+ func DefaultValidationRequestHandler(privVal types.PrivValidator, req ocprivvalproto.Message, chainID string) (ocprivvalproto.Message, error)

+ func GetFreeLocalhostAddrPort() string

+ func IsConnTimeout(err error) bool

+ func WithMockKMS(t *testing.T, dir, chainID string, f func(string, crypto.PrivKey))

+ type EndpointTimeoutError struct

+ func (e EndpointTimeoutError) Error() string

+ func (e EndpointTimeoutError) Temporary() bool

+ func (e EndpointTimeoutError) Timeout() bool

+ type FilePV struct

+ Key FilePVKey

+ LastSignState FilePVLastSignState

+ func GenFilePV(keyFilePath, stateFilePath string) *FilePV

+ func LoadFilePV(keyFilePath, stateFilePath string) *FilePV

+ func LoadFilePVEmptyState(keyFilePath, stateFilePath string) *FilePV

+ func LoadOrGenFilePV(keyFilePath, stateFilePath string) *FilePV

+ func NewFilePV(privKey crypto.PrivKey, keyFilePath, stateFilePath string) *FilePV

+ func (pv *FilePV) GenerateVRFProof(message []byte) (crypto.Proof, error)

+ func (pv *FilePV) GetAddress() types.Address

+ func (pv *FilePV) GetPubKey() (crypto.PubKey, error)

+ func (pv *FilePV) Reset()

+ func (pv *FilePV) Save()

+ func (pv *FilePV) SignProposal(chainID string, proposal *tmproto.Proposal) error

+ func (pv *FilePV) SignVote(chainID string, vote *tmproto.Vote) error

+ func (pv *FilePV) String() string

+ type FilePVKey struct

+ Address types.Address

+ PrivKey crypto.PrivKey

+ PubKey crypto.PubKey

+ func (pvKey FilePVKey) Save()

+ type FilePVLastSignState struct

+ Height int64

+ Round int32

+ SignBytes tmbytes.HexBytes

+ Signature []byte

+ Step int8

+ func (lss *FilePVLastSignState) CheckHRS(height int64, round int32, step int8) (bool, error)

+ func (lss *FilePVLastSignState) Save()

+ type RemoteSignerError struct

+ Code int

+ Description string

+ func (e *RemoteSignerError) Error() string

+ type RetrySignerClient struct

+ func NewRetrySignerClient(sc *SignerClient, retries int, timeout time.Duration) *RetrySignerClient

+ func (sc *RetrySignerClient) Close() error

+ func (sc *RetrySignerClient) GenerateVRFProof(message []byte) (crypto.Proof, error)

+ func (sc *RetrySignerClient) GetPubKey() (crypto.PubKey, error)

+ func (sc *RetrySignerClient) IsConnected() bool

+ func (sc *RetrySignerClient) SignProposal(chainID string, proposal *tmproto.Proposal) error

+ func (sc *RetrySignerClient) SignVote(chainID string, vote *tmproto.Vote) error

+ func (sc *RetrySignerClient) WaitForConnection(maxWait time.Duration) error

+ type SignerClient struct

+ func NewSignerClient(endpoint *SignerListenerEndpoint, chainID string) (*SignerClient, error)

+ func (sc *SignerClient) Close() error

+ func (sc *SignerClient) GenerateVRFProof(message []byte) (crypto.Proof, error)

+ func (sc *SignerClient) GetPubKey() (crypto.PubKey, error)

+ func (sc *SignerClient) IsConnected() bool

+ func (sc *SignerClient) SignProposal(chainID string, proposal *tmproto.Proposal) error

+ func (sc *SignerClient) SignVote(chainID string, vote *tmproto.Vote) error

+ func (sc *SignerClient) WaitForConnection(maxWait time.Duration) error

+ type SignerDialerEndpoint struct

+ func NewSignerDialerEndpoint(logger log.Logger, dialer SocketDialer, options ...SignerServiceEndpointOption) *SignerDialerEndpoint

+ func (se *SignerDialerEndpoint) Close() error

+ func (se *SignerDialerEndpoint) DropConnection()

+ func (se *SignerDialerEndpoint) GetAvailableConnection(connectionAvailableCh chan net.Conn) bool

+ func (se *SignerDialerEndpoint) IsConnected() bool

+ func (se *SignerDialerEndpoint) ReadMessage() (msg privvalproto.Message, err error)

+ func (se *SignerDialerEndpoint) SetConnection(newConnection net.Conn)

+ func (se *SignerDialerEndpoint) WaitConnection(connectionAvailableCh chan net.Conn, maxWait time.Duration) error

+ func (se *SignerDialerEndpoint) WriteMessage(msg privvalproto.Message) (err error)

+ type SignerListenerEndpoint struct

+ func NewSignerListener(listenAddr string, logger log.Logger) (*SignerListenerEndpoint, error)

+ func NewSignerListenerEndpoint(logger log.Logger, listener net.Listener, ...) *SignerListenerEndpoint

+ func (se *SignerListenerEndpoint) Close() error

+ func (se *SignerListenerEndpoint) DropConnection()

+ func (se *SignerListenerEndpoint) GetAvailableConnection(connectionAvailableCh chan net.Conn) bool

+ func (se *SignerListenerEndpoint) IsConnected() bool

+ func (se *SignerListenerEndpoint) ReadMessage() (msg privvalproto.Message, err error)

+ func (se *SignerListenerEndpoint) SetConnection(newConnection net.Conn)

+ func (se *SignerListenerEndpoint) WaitConnection(connectionAvailableCh chan net.Conn, maxWait time.Duration) error

+ func (se *SignerListenerEndpoint) WriteMessage(msg privvalproto.Message) (err error)

+ func (sl *SignerListenerEndpoint) OnStart() error

+ func (sl *SignerListenerEndpoint) OnStop()

+ func (sl *SignerListenerEndpoint) SendRequest(request ocprivvalproto.Message) (*ocprivvalproto.Message, error)

+ func (sl *SignerListenerEndpoint) WaitForConnection(maxWait time.Duration) error

+ type SignerListenerEndpointOption func(*SignerListenerEndpoint)

+ func SignerListenerEndpointTimeoutReadWrite(timeout time.Duration) SignerListenerEndpointOption

+ type SignerServer struct

+ func NewSignerServer(endpoint *SignerDialerEndpoint, chainID string, privVal types.PrivValidator) *SignerServer

+ func (ss *SignerServer) OnStart() error

+ func (ss *SignerServer) OnStop()

+ func (ss *SignerServer) SetRequestHandler(validationRequestHandler ValidationRequestHandlerFunc)

+ type SignerServiceEndpointOption func(*SignerDialerEndpoint)

+ func SignerDialerEndpointConnRetries(retries int) SignerServiceEndpointOption

+ func SignerDialerEndpointRetryWaitInterval(interval time.Duration) SignerServiceEndpointOption

+ func SignerDialerEndpointTimeoutReadWrite(timeout time.Duration) SignerServiceEndpointOption

+ type SocketDialer func() (net.Conn, error)

+ func DialTCPFn(addr string, timeoutReadWrite time.Duration, privKey crypto.PrivKey) SocketDialer

+ func DialUnixFn(addr string) SocketDialer

+ type TCPListener struct

+ func NewTCPListener(ln net.Listener, secretConnKey ed25519.PrivKey) *TCPListener

+ func (ln *TCPListener) Accept() (net.Conn, error)

+ type TCPListenerOption func(*TCPListener)

+ func TCPListenerTimeoutAccept(timeout time.Duration) TCPListenerOption

+ func TCPListenerTimeoutReadWrite(timeout time.Duration) TCPListenerOption

+ type UnixListener struct

+ func NewUnixListener(ln net.Listener) *UnixListener

+ func (ln *UnixListener) Accept() (net.Conn, error)

+ type UnixListenerOption func(*UnixListener)

+ func UnixListenerTimeoutAccept(timeout time.Duration) UnixListenerOption

+ func UnixListenerTimeoutReadWrite(timeout time.Duration) UnixListenerOption

+ type ValidationRequestHandlerFunc func(privVal types.PrivValidator, requestMessage privvalproto.Message, ...) (privvalproto.Message, error)