grpc

package

v0.35.9 Latest Latest Go to latest Published: Jul 20, 2022 License: Apache-2.0 Imports: 22 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func DefaultDialOptions(
	extraOpts ...grpc.DialOption,
) []grpc.DialOption

DefaultDialOptions constructs a list of grpc dial options

func GenerateTLS(certPath, keyPath, ca string, log log.Logger) grpc.DialOption

type SignerClient struct {
	// contains filtered or unexported fields
}

SignerClient implements PrivValidator. Handles remote validator connections that provide signing services

func DialRemoteSigner(
	cfg *config.PrivValidatorConfig,
	chainID string,
	logger log.Logger,
	usePrometheus bool,
) (*SignerClient, error)

DialRemoteSigner is a generalized function to dial the gRPC server.

func NewSignerClient(conn *grpc.ClientConn,
	chainID string, log log.Logger) (*SignerClient, error)

NewSignerClient returns an instance of SignerClient. it will start the endpoint (if not already started)

func (sc *SignerClient) Close() error

Close closes the underlying connection

func (sc *SignerClient) GetPubKey(ctx context.Context) (crypto.PubKey, error)

GetPubKey retrieves a public key from a remote signer returns an error if client is not able to provide the key

func (sc *SignerClient) SignProposal(ctx context.Context, chainID string, proposal *tmproto.Proposal) error

SignProposal requests a remote signer to sign a proposal

func (sc *SignerClient) SignVote(ctx context.Context, chainID string, vote *tmproto.Vote) error

SignVote requests a remote signer to sign a vote

type SignerServer struct {
	// contains filtered or unexported fields
}

SignerServer implements PrivValidatorAPIServer 9generated via protobuf services) Handles remote validator connections that provide signing services

func NewSignerServer(chainID string,
	privVal types.PrivValidator, log log.Logger) *SignerServer

func (ss *SignerServer) GetPubKey(ctx context.Context, req *privvalproto.PubKeyRequest) (
	*privvalproto.PubKeyResponse, error)

PubKey receives a request for the pubkey returns the pubkey on success and error on failure

func (ss *SignerServer) SignProposal(ctx context.Context, req *privvalproto.SignProposalRequest) (
	*privvalproto.SignedProposalResponse, error)

SignProposal receives a proposal sign requests, attempts to sign it returns SignedProposalResponse on success and error on failure

func (ss *SignerServer) SignVote(ctx context.Context, req *privvalproto.SignVoteRequest) (
	*privvalproto.SignedVoteResponse, error)

SignVote receives a vote sign requests, attempts to sign it returns SignedVoteResponse on success and error on failure