grpc

Documentation

Overview

Package grpc implements a grpc payment API server.

Index

• Variables
• func ListenAndServePayChAPI(n perun.NodeAPI, grpcPort string) error
• func ToGrpcBalInfo(src perun.BalInfo) *pb.BalInfo
• func ToGrpcPayment(src payment.Payment) *pb.Payment
• func ToGrpcPayments(payments []payment.Payment) []*pb.Payment

Variables

var ToGrpcChUpdateType = map[perun.ChUpdateType]pb.SubPayChUpdatesResp_Notify_ChUpdateType{
	perun.ChUpdateTypeOpen:   pb.SubPayChUpdatesResp_Notify_open,
	perun.ChUpdateTypeFinal:  pb.SubPayChUpdatesResp_Notify_final,
	perun.ChUpdateTypeClosed: pb.SubPayChUpdatesResp_Notify_closed,
}

ToGrpcChUpdateType is a helper var that maps enums from ChUpdateType type defined in perun-node to ChUpdateType type defined in grpc package.

Functions

func ListenAndServePayChAPI

func ListenAndServePayChAPI(n perun.NodeAPI, grpcPort string) error

ListenAndServePayChAPI starts a payment channel API server that listens for incoming grpc requests at the specified address and serves those requests using the node API instance.

func ToGrpcBalInfo

func ToGrpcBalInfo(src perun.BalInfo) *pb.BalInfo

ToGrpcBalInfo is a helper function to convert BalInfo struct defined in perun-node to BalInfo struct defined in grpc package.

func ToGrpcPayment

func ToGrpcPayment(src payment.Payment) *pb.Payment

ToGrpcPayment is a helper function to convert Payment struct defined in perun-node package to Payment struct defined in gprc package.

func ToGrpcPayments

func ToGrpcPayments(payments []payment.Payment) []*pb.Payment

ToGrpcPayments is a helper function to convert slice of Payment struct defined in perun-node package to slice of Payment struct defined in grpc package.