push

Documentation

Overview

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

Index

• Constants
• Variables
• func ParseEvent(event abci.Event, blockHeight uint64) (*store.Event, error)
• type Client
  • func NewClient(database *db.DB, chainConfig *config.ChainSpecificConfig, ...) (*Client, error)
  • func (c *Client) GetTxBuilder() (common.OutboundTxBuilder, error)
  • func (c *Client) IsHealthy() bool
  • func (c *Client) Start(ctx context.Context) error
  • func (c *Client) Stop() error
• type Config
  • func (c *Config) Validate() error
• type EventListener
  • func NewEventListener(pushCore *pushcore.Client, database *db.DB, logger zerolog.Logger, ...) (*EventListener, error)
  • func (el *EventListener) IsRunning() bool
  • func (el *EventListener) Start(ctx context.Context) error
  • func (el *EventListener) Stop() error

Constants

const (
	DefaultPollInterval = 5 * time.Second
	DefaultChunkSize    = 1000
	DefaultQueryLimit   = 100
)

Default configuration values

const (
	TSSEventQuery      = EventTypeTSSProcessInitiated + ".process_id>=0"
	OutboundEventQuery = EventTypeOutboundCreated + ".tx_id EXISTS"
)

Event queries for fetching specific event types from the chain.

const (
	EventTypeTSSProcessInitiated = utsstypes.EventTypeTssProcessInitiated
	EventTypeOutboundCreated     = uexecutortypes.EventTypeOutboundCreated
)

Event type constants

const (
	AttrKeyProcessID    = "process_id"
	AttrKeyProcessType  = "process_type"
	AttrKeyParticipants = "participants"
	AttrKeyExpiryHeight = "expiry_height"
)

TSS event attribute keys.

const (
	ChainProcessTypeKeygen       = "TSS_PROCESS_KEYGEN"
	ChainProcessTypeRefresh      = "TSS_PROCESS_REFRESH"
	ChainProcessTypeQuorumChange = "TSS_PROCESS_QUORUM_CHANGE"
)

TSS process type values as defined in the Push chain.

const (
	AttrKeyTxID             = "tx_id"
	AttrKeyUniversalTxID    = "utx_id"
	AttrKeyOutboundID       = "outbound_id"
	AttrKeyDestinationChain = "destination_chain"
	AttrKeyRecipient        = "recipient"
	AttrKeyAmount           = "amount"
	AttrKeyAssetAddr        = "asset_addr"
	AttrKeySender           = "sender"
	AttrKeyPayload          = "payload"
	AttrKeyGasFee           = "gas_fee"
	AttrKeyGasLimit         = "gas_limit"
	AttrKeyGasPrice         = "gas_price"
	AttrKeyGasToken         = "gas_token"
	AttrKeyTxType           = "tx_type"
	AttrKeyPcTxHash         = "pc_tx_hash"
	AttrKeyLogIndex         = "log_index"
	AttrKeyRevertMsg        = "revert_msg"
	AttrKeyData             = "data"
)

Outbound event attribute keys.

const OutboundExpiryOffset = 1000

OutboundExpiryOffset is the number of blocks after event detection before an outbound event expires.

Variables

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")
)

Errors

var (
	ErrMissingProcessID    = errors.New("missing required attribute: process_id")
	ErrMissingProcessType  = errors.New("missing required attribute: process_type")
	ErrMissingTxID         = errors.New("missing required attribute: tx_id")
	ErrInvalidProcessID    = errors.New("invalid process_id format")
	ErrInvalidExpiryHeight = errors.New("invalid expiry_height format")
	ErrInvalidParticipants = errors.New("invalid participants format")
)

Parser errors.

Functions

func ParseEvent

func ParseEvent(event abci.Event, blockHeight uint64) (*store.Event, error)

ParseEvent parses a Push chain event from an ABCI event. Returns nil if the event type is not recognized. Sets BlockHeight and Status on successfully parsed events.

Types

type Client

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

Client implements the ChainClient interface for Push chain

func NewClient

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

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

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

func (*Client) IsHealthy

func (c *Client) IsHealthy() bool

IsHealthy checks if the Push chain RPC Client is healthy

func (*Client) Start

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

Start initializes and starts the Push chain client

func (*Client) Stop

func (c *Client) Stop() error

Stop gracefully shuts down the Push chain client

type Config

type Config struct {
	PollInterval time.Duration
	ChunkSize    uint64
	QueryLimit   uint64
}

Config holds configuration for the Push event listener

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration

type EventListener

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

EventListener listens for events from the Push chain and stores them in the database

func NewEventListener

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

func (el *EventListener) IsRunning() bool

IsRunning returns whether the event listener is currently running

func (*EventListener) Start

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

Start begins listening for events from the Push chain

func (*EventListener) Stop

func (el *EventListener) Stop() error

Stop gracefully stops the event listener