push

package

v0.0.41 Latest Latest Go to latest Published: Jul 14, 2026 License: MIT Imports: 16 Imported by: 0

Details

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

Repository

github.com/pushchain/push-chain-node

Links

Open Source Insights

Documentation ¶

Overview ¶

Package push provides a client for listening to Push Chain events.

Index ¶

Constants
Variables
type Client
- func NewClient(database *db.DB, chainConfig *config.ChainSpecificConfig, ...) (*Client, error)
type Config
type EventListener
- func NewEventListener(pushCore *pushcore.Client, database *db.DB, logger zerolog.Logger, ...) (*EventListener, error)

Constants ¶

View Source

const DefaultPollInterval = 2 * time.Second

Variables ¶

View Source

var (
	ErrNilClient      = errors.New("push client is nil")
	ErrNilDatabase    = errors.New("database is nil")
	ErrAlreadyRunning = errors.New("event listener is already running")
	ErrNotRunning     = errors.New("event listener is not running")
)

Functions ¶

This section is empty.

Types ¶

type Client ¶ added in v0.0.13

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

Client implements the ChainClient interface for Push chain

func NewClient ¶ added in v0.0.13

func NewClient(
	database *db.DB,
	chainConfig *config.ChainSpecificConfig,
	pushCore *pushcore.Client,
	chainID string,
	logger zerolog.Logger,
) (*Client, error)

NewClient creates a new Push chain client

func (*Client) GetTxBuilder ¶ added in v0.0.13

func (c *Client) GetTxBuilder() (common.TxBuilder, error)

GetTxBuilder returns the TxBuilder for this chain Push chain does not support outbound transactions, so this always returns an error

func (*Client) IsHealthy ¶ added in v0.0.13

func (c *Client) IsHealthy() bool

IsHealthy checks if the Push chain RPC Client is healthy

func (*Client) Start ¶ added in v0.0.13

func (c *Client) Start(ctx context.Context) error

Start initializes and starts the Push chain client

func (*Client) Stop ¶ added in v0.0.13

func (c *Client) Stop() error

Stop gracefully shuts down the Push chain client

type Config ¶

type Config struct {
	PollInterval time.Duration
}

Config holds configuration for the Push event listener.

type EventListener ¶ added in v0.0.13

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

EventListener polls Push chain for active TSS events and pending outbounds via gRPC, converts them to store.Events, and inserts them into the local DB.

func NewEventListener ¶ added in v0.0.13

func NewEventListener(
	pushCore *pushcore.Client,
	database *db.DB,
	logger zerolog.Logger,
	chainConfig *config.ChainSpecificConfig,
) (*EventListener, error)

NewEventListener creates a new Push event listener.

func (*EventListener) IsRunning ¶ added in v0.0.13

func (el *EventListener) IsRunning() bool

IsRunning returns whether the event listener is currently running.

func (*EventListener) Start ¶ added in v0.0.13

func (el *EventListener) Start(ctx context.Context) error

Start begins polling for Push chain events.

func (*EventListener) Stop ¶ added in v0.0.13

func (el *EventListener) Stop() error

Stop gracefully stops the event listener.

Source Files ¶

View all Source files

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