payer

package

v1.0.0 Latest Latest Go to latest Published: Nov 27, 2025 License: MIT Imports: 32 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/xmtp/xmtpd

Links

Open Source Insights

Documentation ¶

Overview ¶

Package payer implements the Payer API service.

Index ¶

func HashKey(topic topic.Topic) uint32
type ClientManager
- func NewClientManager(logger *zap.Logger, nodeRegistry registry.NodeRegistry, ...) *ClientManager
- func (c *ClientManager) GetClientConnection(nodeID uint32) (*grpc.ClientConn, error)
type NodeSelectorAlgorithm
type Service
- func NewPayerAPIService(ctx context.Context, logger *zap.Logger, nodeRegistry registry.NodeRegistry, ...) (*Service, error)
- func (s *Service) GetNodes(ctx context.Context, req *connect.Request[payer_api.GetNodesRequest]) (*connect.Response[payer_api.GetNodesResponse], error)
- func (s *Service) PublishClientEnvelopes(ctx context.Context, ...) (*connect.Response[payer_api.PublishClientEnvelopesResponse], error)
type StableHashingNodeSelectorAlgorithm
- func NewStableHashingNodeSelectorAlgorithm(reg registry.NodeRegistry) *StableHashingNodeSelectorAlgorithm
- func (s *StableHashingNodeSelectorAlgorithm) GetNode(topic topic.Topic, banlist ...[]uint32) (uint32, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func HashKey ¶ added in v0.2.0

func HashKey(topic topic.Topic) uint32

HashKey hashes the topic to a stable uint16 hash

Types ¶

type ClientManager ¶ added in v0.1.1

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

func NewClientManager ¶ added in v0.1.1

func NewClientManager(
	logger *zap.Logger,
	nodeRegistry registry.NodeRegistry,
	clientMetrics *grpcprom.ClientMetrics,
) *ClientManager

func (*ClientManager) GetClientConnection ¶ added in v1.0.0

func (c *ClientManager) GetClientConnection(nodeID uint32) (*grpc.ClientConn, error)

type NodeSelectorAlgorithm ¶ added in v0.2.0

type NodeSelectorAlgorithm interface {
	GetNode(topic topic.Topic, banlist ...[]uint32) (uint32, error)
}

type Service ¶

type Service struct {
	payer_apiconnect.UnimplementedPayerApiHandler
	// contains filtered or unexported fields
}

func NewPayerAPIService ¶ added in v0.5.1

func NewPayerAPIService(
	ctx context.Context,
	logger *zap.Logger,
	nodeRegistry registry.NodeRegistry,
	payerPrivateKey *ecdsa.PrivateKey,
	blockchainPublisher blockchain.IBlockchainPublisher,
	clientMetrics *grpcprom.ClientMetrics,
	maxPayerMessageSize uint64,
) (*Service, error)

func (*Service) GetNodes ¶ added in v1.0.0

func (s *Service) GetNodes(
	ctx context.Context,
	req *connect.Request[payer_api.GetNodesRequest],
) (*connect.Response[payer_api.GetNodesResponse], error)

GetNodes returns the complete endpoint list of canonical nodes.

func (*Service) PublishClientEnvelopes ¶

func (s *Service) PublishClientEnvelopes(
	ctx context.Context,
	req *connect.Request[payer_api.PublishClientEnvelopesRequest],
) (*connect.Response[payer_api.PublishClientEnvelopesResponse], error)

type StableHashingNodeSelectorAlgorithm ¶ added in v0.2.0

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

func NewStableHashingNodeSelectorAlgorithm ¶ added in v0.2.0

func NewStableHashingNodeSelectorAlgorithm(
	reg registry.NodeRegistry,
) *StableHashingNodeSelectorAlgorithm

func (*StableHashingNodeSelectorAlgorithm) GetNode ¶ added in v0.2.0

func (s *StableHashingNodeSelectorAlgorithm) GetNode(
	topic topic.Topic,
	banlist ...[]uint32,
) (uint32, error)

GetNode selects a node for a given topic using stable hashing

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL